You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I think you could consider streamlining documentation by differentiating the roles of the README and Wiki. Currently, they're mirrored, which leads to redundancy. I propose a cleaner, more concise README focused on a quick overview, key features, and automated installation.
Like:
Introduction // here could be educational purpose only note, and all about it
Features // what it can do (so far, and for example link to wiki/projects)
Installation // automated, and maybe like small block with "if searching for manual installation go to [wiki link]"
Prerequisites
Quick Start // how to start it on RPI
Usage Examples // sample of scans/reading data
Contributing // how to contribute (maybe link to CONTRIBUTING.md or projects)
Contact // contact
License // license
Detailed information like troubleshooting, known issues, and manual installation steps could be moved to the Wiki. This would make the README more approachable for users while keeping comprehensive documentation readily available for those who need it. A simple link in the README referencing the Wiki for further details would bridge the gap. Thoughts?
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
I think you could consider streamlining documentation by differentiating the roles of the README and Wiki. Currently, they're mirrored, which leads to redundancy. I propose a cleaner, more concise README focused on a quick overview, key features, and automated installation.
Like:
Detailed information like troubleshooting, known issues, and manual installation steps could be moved to the Wiki. This would make the README more approachable for users while keeping comprehensive documentation readily available for those who need it. A simple link in the README referencing the Wiki for further details would bridge the gap. Thoughts?
Beta Was this translation helpful? Give feedback.
All reactions