AOSSIE-Org / AOSSIE-Org/PictoPy
DOC:Improve onboarding clarity and navigation in documentation
- Langage dominant
- Python
- Étoiles
- 283
- Forks
- 679
- Merge moyen
- 7 j 2 h
- PR mergées (30 j)
- 3
Description
### What's wrong with the existing documentation
Hi maintainers 👋
I’ve set up the PictoPy documentation locally and explored the docs as a new contributor.
While going through the documentation, I noticed a few areas where onboarding and navigation could be improved for first-time users:
- A clearer “Getting Started” flow for new contributors
- Making the Setup section more prominent and easier to follow
- Adding a short high-level overview before detailed backend sections
- Better grouping or cross-linking of related documentation pages
I’d be happy to work on improving the documentation if this aligns with the project’s goals.
Please let me know your thoughts.
### Add ScreenShots
_No response_
### Record
- [x] I agree to follow this project's Code of Conduct
- [x] I want to work on this issue
Guide de contribution
Ouvrir le guide de contribution
Évaluation
Cette issue n'a pas encore été évaluée.