Docs: 考虑调整现行文档中部分章节的顺序
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 7.7k
- Forks
- 662
- Avg merge
- 7d 15h
- Merged PRs (30d)
- 7
Description
描述问题或主题
很多初学者阅读文档时会按照文档的编排顺序进行学习与操作，然而目前文档的编排顺序并不足够利于初学者上手。例如：
- “手动创建项目”章节为普通用户不必详细了解的内容，然而其被安排在“指南”的第一节；
普通用户应尽可能使用 nb-cli 脚手架完成操作。
- “获取商店内容”章节为普通用户和开发者均应了解的内容，其被安排在“指南”的中部；
普通用户从商店中快速选用想要的功能插件并利用 nb-cli 进行安装，开发者从商店中选用需要的工具库。
- “编辑器支持”章节情况与“手动创建项目”章节类似。
需做出的修改
个人的想法：
- “手动创建项目”章节应置于“深入”或“进阶”部分；
- “获取商店内容”章节应置于“开始”部分；
- “编辑器支持”章节应置于“指南”部分。
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the documentation navigation and the chapters titled “手动创建项目”, “获取商店内容”, and “编辑器支持”. Review their current placement and reorganize them so manual project creation is under advanced content, store content is under getting started, and editor support is under the guide section.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100