# Check Docs

> Verify that the docs/ site, README.md, and CHANGES.md are current with the code: nav links resolve, documented commands and options still exist, and version references match the current version in package.json.

- Skill: `lorem-dev/check-docs` (Agent Skill)
- Install (CLI): `npx skillmds@latest add lorem-dev/check-docs`
- Raw SKILL.md: https://api.skillmd.com/api/skills/lorem-dev/check-docs/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: lorem-dev (https://skillmd.com/u/lorem-dev)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/lorem-dev/check-docs

---


# check-docs

Verify that all project documentation is accurate and up to date.

## Steps

1. **Read the current version.**
   Open the root `package.json` and note the `version` field. The Rust
   workspace version in `Cargo.toml` (`workspace.package.version`) and the
   desktop app version in `apps/desktop/src-tauri/tauri.conf.json` must match
   it.

2. **Check README.md.**
   - Confirm every command shown in README.md exists: `pnpm` scripts
     (`pnpm lint`, `pnpm test:cov`, etc.) as scripts in the root `package.json`
     or the relevant package `package.json`; `cargo` commands (`cargo test`,
     `cargo clippy`, `cargo run -p skillkeeper-cli`, etc.) against the Rust
     workspace in `Cargo.toml`.
   - Confirm the `--filter` names (`@skillkeeper/desktop`, `@skillkeeper/i18n`)
     match the `name` fields in the respective `package.json` files.
   - Confirm the docs directory reference (`docs/`) exists.

3. **Check docs/ navigation.**
   Open `mkdocs.yml` and verify:
   - Every file listed under `nav:` exists under `docs/`.
   - No nav entry points to a missing file.

4. **Check documented CLI commands.**
   For each command documented in `docs/` (look for fenced code blocks with
   `skillkeeper` invocations), verify the corresponding clap command still
   exists in `crates/skillkeeper-cli/src/`. Use `codegraph_search` or file
   inspection to confirm command names and option flags are present in the
   source.

5. **Check version references.**
   Search `docs/` and `README.md` for version strings. Any hardcoded version
   (e.g., `1.0.0`) must match the version in root `package.json`.

6. **Check CHANGES.md structure.**
   Confirm the file carries its rules comment block, that `## Development` is
   the first heading after it, and that previous release sections follow the
   `## Version X.Y.Z` heading format (no date). The block sits above
   `## Development` on purpose: `release-notes.mjs` extracts only from a
   `## Version` heading to the next `## `, so anything above the first one
   never reaches a GitHub release.

7. **Report.**
   List every issue found (missing files, broken nav links, stale commands,
   version mismatches). If everything is current, report "Docs are current."
   Do not edit documentation automatically -- propose corrections and let the
   developer apply them.