AOSSIE-Org / AOSSIE-Org/PictoPy
DOC:Improve onboarding clarity and navigation in documentation
- Dominant language
- Python
- Stars
- 283
- Forks
- 679
- Avg merge
- 7d 2h
- Merged PRs (30d)
- 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
Contributor guide
Assessment
This issue has not been assessed yet.