AOSSIE-Org / AOSSIE-Org/PictoPy

DOC:Improve onboarding clarity and navigation in documentation

Aperta
#924 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
283
Fork
679
Merge medio
7g 2h
PR unite (30g)
3

Descrizione

### 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

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non ĆØ ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.