@banana-peeljj12/dsh-docs
专门用于维护项目文档与 LikeC4 架构即代码的 DeepSeek Harness (DSH) 插件。提供 Docsify Wiki 自动治理、LikeC4 看板构建与语法校验、结构化文档读取与原子更新、坏链体检、ADR 脚手架以及 Web UI 控制台。
核心特性
- Wiki 静态页面自动维护：
- 自动扫描 Markdown 目录树并生成/同步规范的
_sidebar.md；
- 保护开发者手工维护的特殊链接区块（
<!-- custom-links-start -->）；
- 内置基于 Node.js 的轻量本地实时预览 HTTP 服务器（支持 CORS / 自动端口避让）。
- LikeC4 架构即代码构建与校验：
- 优先探测项目本地
node_modules/.bin/likec4，无缝调度；
- 语法格式与架构语义校验，提供清晰的文件、行号、列号结构化错误；
- 一键构建交互式静态架构看板（生成纯静态 HTML/JS 产物）；
- 自动将架构看板挂载至 Wiki 侧边栏导航。
- 文档结构化读取与安全更新：
docs_read：按章节标题精准抽取段落、Frontmatter 元数据与大纲目录；docs_update：支持全量覆盖、末尾追加与单章节替换，具备 Git 未提交修改防冲保护与 dry_run 差异对比，写入自动创建 .bak 备份。
- 工程质量体检套件：
- 死链与断图检测（
docs_audit）：全量排查相对链接、图片路径与已删除文件；
- 孤立文档扫描：发现未在目录树和侧边栏收录的遗留文档；
- ADR 自动脚手架（
docs_adr_create）：自动提取最大编号并递增（如 ADR-014-...），套用标准模板并自动挂载至侧边栏。
- 双模路径配置：
- 支持在工作区
.dsh/docs-config.json 中持久化配置 docsRoot 与 c4Root；
- 每次调用均支持通过入参动态显式覆盖，支持多文档域管理。
- DSH Web UI 客户端扩展：
- 注入 DSH 右侧栏抽屉式工作台，一键触发构建、同步与体检。
DSH Agent Tools 清单
| 工具名 | 说明 |
|---|
docs_config | 获取或设置文档根目录与 C4 架构根目录配置 |
docs_read | 结构化读取文档内容、指定章节与大纲目录 |
docs_update | 安全更新文档（支持 mode: overwrite/append/replace_section、dryRun、Git 脏检查） |
docs_wiki_generate | 自动扫描文档目录并生成/同步 _sidebar.md |
docs_wiki_preview | 启动、停止或查询本地 Docsify 预览服务器 |
docs_c4_validate | 校验 LikeC4 模型与文件语法，输出行号错误 |
docs_c4_build | 编译构建 LikeC4 静态交互看板（输出到 dist/） |
docs_audit | 全面体检文档质量（死链、断图、孤立文档、健康评分） |
docs_adr_create | 一键按规范创建递增编号的 ADR 决策文档并自动挂载目录 |
CIDI 管线（CI/CD + 文档集成）
仓库内置两条工作流，代码质量与文档/架构集成同时过关才允许发布：
| 工作流 | 内容 | 触发 |
|---|
CI | Node 22/24 测试矩阵、npm run pipeline 文档管线、npm pack 产物校验 | push / PR / 手动 |
Release | 测试与文档管线 → npm publish → 从 CHANGELOG.md 提取 Release Notes → GitHub Release | tag v* / 手动 |
本地等价的提交前检查：
npm ci
npm run ci # = npm test && npm run pipeline
npm run pack:check
完整阶段说明、fixture 设计与发布约定见 docs/PIPELINE.md。
运行测试
cd E:/dsh_plugins/dsh-docs
npm test # 36 项单元测试（临时 fixture，无本机路径依赖）
npm run pipeline # Wiki → ADR → 审计 → LikeC4 校验/构建 端到端管线
开源协议
MIT License
