AOSSIE-Org / AOSSIE-Org/PictoPy

DOC:Improve onboarding clarity and navigation in documentation

未關閉
#924 4 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
Python
星號
283
分支
679
平均合併
7 天 2 小時
30 天內合併 PR
3

描述

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

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。