The latest articles on Forem by Ryan Millard (@ryanmillard). https://forem.com/ryanmillard https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F3714735%2F1debad00-a287-4d0c-9818-a791442c79e3.jpeg https://forem.com/ryanmillard en Ryan Millard Fri, 16 Jan 2026 12:01:59 +0000 https://forem.com/ryanmillard/seeking-feedback-on-documentation-and-guidelines-for-img2num-31ao https://forem.com/ryanmillard/seeking-feedback-on-documentation-and-guidelines-for-img2num-31ao <p>Hello everyone!</p> <p>I’m the lead maintainer of <a href="https://github.com/Ryan-Millard/Img2Num" rel="noopener noreferrer">Img2Num</a>, 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 <strong>raster-to-SVG vectorization library</strong>.</p> <p>I’ve written a fair amount of guides and documentation, including setup instructions, contributing guidelines, and coding standards, but I’ve noticed recurring issues: <strong>even with the docs, people often get confused or skip steps</strong>. This makes me realize there’s room to improve clarity, structure, and approachability.</p> <p>I’m reaching out to ask for help or some constructive feedback on my repository’s documentation, contribution rules, and overall guidance. </p> <p>Specifically, I’d love help with answering these questions:</p> <ul> <li>Are the installation and usage instructions clear?</li> <li>Are the contribution guidelines understandable, especially around CI checks and code formatting?</li> <li>Do the docs explain the purpose and structure of the project effectively, especially now that the goal has shifted?</li> <li>Any general suggestions to make the repo more approachable for first-time contributors.</li> </ul> <p>You can check out the repo here: <a href="https://github.com/Ryan-Millard/Img2Num" rel="noopener noreferrer">https://github.com/Ryan-Millard/Img2Num</a></p> <p>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.</p> <p>Thanks in advance!</p> documentation opensource cpp