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 摘要。