From doc-smith
Validates Doc-Smith workspace structure via YAML and content integrity in dist/ and docs/, checking HTML files, meta.yaml, nav.js, internal links, images, and asset paths. Internal tool for other Doc-Smith skills.
npx claudepluginhub aigne-io/doc-smith-skills --plugin doc-smithThis skill uses the workspace's default tool permissions.
校验 Doc-Smith workspace 的结构和内容完整性。
Validates project documentation: lints formatting and naming, checks broken/orphan links, verifies glossary terms and synonyms, detects contradictions/gaps, audits completeness via /doc:lint, /doc:links, etc.
Fetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.
Executes ctx7 CLI to fetch up-to-date library documentation, manage AI coding skills (install/search/generate/remove/suggest), and configure Context7 MCP. Useful for current API refs, skill handling, or agent setup.
Share bugs, ideas, or general feedback.
校验 Doc-Smith workspace 的结构和内容完整性。
/doc-smith-check # 全部检查(结构 + 内容)
/doc-smith-check --structure # 只检查结构
/doc-smith-check --content # 只检查内容
/doc-smith-check --content --path /api/auth # 检查指定文档
| 选项 | 别名 | 说明 |
|---|---|---|
--structure | -s | 只运行结构检查 |
--content | -c | 只运行内容检查 |
--path <docPath> | -p | 指定文档路径(可多次使用,仅与 --content 配合) |
执行脚本:node skills/doc-smith-check/scripts/check-structure.mjs
校验 planning/document-structure.yaml:
/ 开头执行脚本:node skills/doc-smith-check/scripts/check-content.mjs [--path <p>]
校验 dist/ 中的 HTML 和 docs/ 中的元数据:
| 校验项 | 说明 |
|---|---|
| HTML 文件存在 | dist/{lang}/docs/{path}.html |
| .meta.yaml 存在 | docs/{path}/.meta.yaml,含 kind/source/default |
| nav.js 存在 | dist/assets/nav.js |
| 内部链接有效 | 链接目标文档存在,无 .md 后缀 |
| 图片可访问 | 本地图片文件存在,远程图片可达 |
| 路径格式 | MD 源文件应使用 /assets/ 格式,../../assets/ 旧格式产生警告 |
内容校验自动包含路径格式检查:
docs/{path}/ 下存在 .md 源文件,检查其中的图片引用格式/assets/xxx 格式 → 通过../../assets/xxx 旧格式 → 产生警告,建议迁移到 /assets/ 格式document-structure.yaml,重新检查cd skills/doc-smith-check/scripts && npm install/doc-smith-check --structure/doc-smith-check --content/doc-smith-check