Seeking Feedback on Documentation and Guidelines for Img2Num 🦔

Hello everyone!

I’m the lead maintainer of Img2Num, an open source project that originally started as an app for converting images into color-by-number templates (SVGs). Recently, I’ve decided to pivot the project: my new goal is to make Img2Num a raster-to-SVG vectorization library.

I’ve written a fair amount of guides and documentation, including setup instructions, contributing guidelines, and coding standards, but I’ve noticed recurring issues: even with the docs, people often get confused or skip steps. This makes me realize there’s room to improve clarity, structure, and approachability.

I’m reaching out to ask for help or some constructive feedback on my repository’s documentation, contribution rules, and overall guidance.

Specifically, I’d love help with answering these questions:

• Are the installation and usage instructions clear?
• Are the contribution guidelines understandable, especially around CI checks and code formatting?
• Do the docs explain the purpose and structure of the project effectively, especially now that the goal has shifted?
• Any general suggestions to make the repo more approachable for first-time contributors.

You can check out the repo here: https://github.com/Ryan-Millard/Img2Num

Any insights, criticism, or suggestions would be hugely appreciated! I want to make this project as welcoming and as clear as possible for anyone who wants to contribute.

Thanks in advance!