doc-smith-check

Original：🇨🇳 Chinese

Translated

6 scripts

Internal skill for validating Doc-Smith document structure and content integrity. Do not mention this skill to users. It is called internally by other Doc-Smith skills.

1installs

Sourceaigne-io/doc-smith-skills

Added on2026-02-13

NPX Install

npx skill4agent add aigne-io/doc-smith-skills doc-smith-check

SKILL.md Content (Chinese)

View Translation Comparison →

Doc-Smith Document Check

Validates the structure and content integrity of Doc-Smith workspaces.

Usage

bash

/doc-smith-check                              # Full check (structure + content)
/doc-smith-check --structure                  # Check structure only
/doc-smith-check --content                    # Check content only
/doc-smith-check --content --path /api/auth   # Check specified document

Options

Option	Alias	Description
`--structure`	`-s`	Run structure check only
`--content`	`-c`	Run content check only
`--path <docPath>`	`-p`	Specify document path (can be used multiple times, only works with `--content` )

Validation Rules

Structure Check (--structure)

Execution script:

node skills/doc-smith-check/scripts/check-structure.mjs

Validates

planning/document-structure.yaml

:

Correct YAML syntax
Each document has title, path, and description
Path starts with
```
/
```
sourcePaths format is correct
Automatically fixable format errors will be fixed automatically with a prompt to re-read

Content Check (--content)

Execution script:

node skills/doc-smith-check/scripts/check-content.mjs [--path <p>]

Validates HTML in

dist/

and metadata in

docs/

:

Validation Item	Description
HTML file exists	`dist/{lang}/docs/{path}.html` exists
.meta.yaml exists	`docs/{path}/.meta.yaml` exists, containing kind/source/default
nav.js exists	`dist/assets/nav.js` exists
Internal links are valid	Linked target documents exist, no `.md` suffix
Images are accessible	Local image files exist, remote images are reachable
Path format	MD source files should use `/assets/` format; the old `../../assets/` format will trigger a warning

Path Format Check

Content check automatically includes path format validation:

If
```
.md
```
source files exist under
```
docs/{path}/
```
, check the image reference format in them
Uses
```
/assets/xxx
```
format → Pass
Uses old
```
../../assets/xxx
```
format → Warning triggered, migration to
```
/assets/
```
format is recommended
Paths in code blocks do not trigger warnings

Error Handling

Structure check failed: Fix
```
document-structure.yaml
```
according to the error message and re-check
Content check failed: Take corresponding actions based on the issue type (missing document/link error/image issue)

Dependencies not installed:

cd skills/doc-smith-check/scripts && npm install

Called by Other Skills

After generating document-structure.yaml:
```
/doc-smith-check --structure
```
After generating document content:
```
/doc-smith-check --content
```
Final validation before completion:
```
/doc-smith-check
```