Skip to content

docs: 将行为准则接入文档站 - #705

Merged
DavidLYP merged 1 commit into
OpenHUTB:masterfrom
DavidLYP:docs/code-of-conduct-page
Nov 16, 2026
Merged

DavidLYP merged 1 commit into
OpenHUTB:masterfrom
DavidLYP:docs/code-of-conduct-page

Conversation

@DavidLYP

Copy link
Copy Markdown
Contributor

变更说明

将已合并的组织级行为准则接入 MkDocs 文档站,让读者可以从文档站直接阅读,而不只停留在 GitHub 根目录文件。

实现方式

  • 保持根目录 CODE_OF_CONDUCT.md 为唯一正文源文件。
  • hooks.py 在构建前将源文件复制为 docs/community/code-of-conduct.md。
  • 在 mkdocs.yml 的“贡献相关”导航中加入“社区行为准则”。
  • 生成页的“编辑页面”和“最近一次修改”都指向根目录源文件,避免编辑到构建副本。
  • .gitignore 忽略构建生成的页面。
  • 更新文档链接、导航和 hooks 回归测试。

验证

关联已合并 PR #703。

构建时从根目录 CODE_OF_CONDUCT.md 生成 community/code-of-conduct.md,加入导航,并让编辑链接和页面历史指向根目录源文件。
@xy18574557330

Copy link
Copy Markdown
Contributor

没有问题,可以合并

@DavidLYP
DavidLYP merged commit bf1c2a5 into OpenHUTB:master Nov 16, 2026
1 check passed
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.

2 participants