Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: 考虑调整现行文档中部分章节的顺序 #3057

Open
NCBM opened this issue Oct 22, 2024 · 0 comments · May be fixed by #3058
Open

Docs: 考虑调整现行文档中部分章节的顺序 #3057

NCBM opened this issue Oct 22, 2024 · 0 comments · May be fixed by #3058
Labels
documentation Improvements or additions to documentation

Comments

@NCBM
Copy link
Contributor

NCBM commented Oct 22, 2024

描述问题或主题

很多初学者阅读文档时会按照文档的编排顺序进行学习与操作,然而目前文档的编排顺序并不足够利于初学者上手。例如:

  • “手动创建项目”章节为普通用户不必详细了解的内容,然而其被安排在“指南”的第一节;

    普通用户应尽可能使用 nb-cli 脚手架完成操作。

  • “获取商店内容”章节为普通用户和开发者均应了解的内容,其被安排在“指南”的中部;

    普通用户从商店中快速选用想要的功能插件并利用 nb-cli 进行安装,开发者从商店中选用需要的工具库。

  • “编辑器支持”章节情况与“手动创建项目”章节类似。

需做出的修改

个人的想法:

  • “手动创建项目”章节应置于“深入”或“进阶”部分;
  • “获取商店内容”章节应置于“开始”部分;
  • “编辑器支持”章节应置于“指南”部分。
@NCBM NCBM added the documentation Improvements or additions to documentation label Oct 22, 2024
@NCBM NCBM linked a pull request Oct 22, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

Successfully merging a pull request may close this issue.

1 participant