跳转至

山海工枢(shanforge)

这是 山海工枢(shanforge) 的正式项目文档源。当前仓库已经按 4 大模块完成单轴重构,其中 项目开发文档(内) 承载治理、需求、设计、测试、发布、运维和追踪矩阵等过程性文档;对外阅读入口和开发者稳定说明不再与内部过程文档混写。

适用范围

  • docs/index.md 的 front matter 是目录树、页面路径和访问级别的唯一事实源。
  • Markdown 页面、OpenAPI 契约和 MCP tools 快照统一作为正式页面资产维护。
  • 契约文件必须放在真实文档目录下,并与所在目录的 index.md 配套。

维护规则

  • 只有根 docs/index.md 声明全站 mkdocs.nav、页面路径和页面权限。
  • 子目录 index.md 只作为正文首页和资源权限锚点,不再承担导航声明职责。
  • 页面、图片和附件跟随所属目录维护;资源文件放在当前目录或当前目录的 assets/ 下,assets/ 不承载 Markdown 页面或契约文件。
  • 仓内链接统一使用相对路径,不写机器绝对路径。
  • 新增、删除或移动 Markdown 页面或契约文件后,同步刷新根 docs/index.md 的目录树;子目录 index.md 只保留正文概览。