Skip to content

docs: 补充安装说明 - #624

Open
15197296515-source wants to merge 4 commits into
OpenHUTB:masterfrom
15197296515-source:fix-docs
Open

15197296515-source wants to merge 4 commits into
OpenHUTB:masterfrom
15197296515-source:fix-docs

Conversation

@15197296515-source

Copy link
Copy Markdown
Contributor

列表只有一项、编号悬着;且 CONTRIBUTING.md 的 VS Code 路线就靠这个扩展

变更内容

简述本次修改做了什么、为什么修改。

关联 Issue:Closes #

变更范围

  • 文档内容(markdown)
  • 配置 / 批处理 / 脚本
  • 其他:______

自查清单

  • 仅包含与本次变更相关的文件(无夹带修改)
  • 涉及链接 / 图片路径的目标均已确认存在
  • 配置 / 脚本格式正确,并已在本地验证

社区协作提示:请勿在 PR 中夹带无关文件的修改;修改链接前请确认目标页面真实存在,并在描述中说明链接指向的具体目标。

列表只有一项、编号悬着;且 CONTRIBUTING.md 的 VS Code 路线就靠这个扩展

Signed-off-by: xuzzw <15197296515@139.com>
全文没有一级标题,页内目录整体错位一级

Signed-off-by: xuzzw <15197296515@139.com>
@fengchuibanxia111

Copy link
Copy Markdown
Contributor

问题与改动

问题:docs/dev/vscode_push.md 的插件清单里,第二条 GitHub Pull Requests 被写在了第一条的同一行,Markdown 只会渲染成一条,第二个插件不会单独显示出来。

改:把第二条另起一行,写成独立的列表项:

  1. Chinese (Simplified) Language Pack —— 中文语言包(可选,适合不习惯英文界面)
  2. GitHub Pull Requests —— 在 VS Code 里直接查看、创建和更新 PR

docs/bib_reference_guide.md:页面标题改为「参考文献引用与编译方法」,与正文内容对应;标题级别和本页小节保持一致。

本次只改这两篇 Markdown 文档,未改正文代码,也未删除页面;本地未跑 mkdocs 构建,站点构建交给 PR 工作流验证。

Signed-off-by: xuzzw <15197296515@139.com>
@15197296515-source

Copy link
Copy Markdown
Contributor Author

已按反馈修改,请查看

@zheyexia10

Copy link
Copy Markdown
Contributor

审核结论:Request changes

docs/dev/vscode_push.md 新增的列表项写成了 2. 2. GitHub Pull Requests,页面会重复显示编号。这里应删掉第二个 2. ,改为:

2. GitHub Pull Requests —— 在 VS Code 里直接查看、创建和更新 PR

其余标题调整正常,PR Build 已通过。

Signed-off-by: xuzzw <15197296515@139.com>
@15197296515-source

Copy link
Copy Markdown
Contributor Author

已修改请查看

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants