How do I install the Check Docs skill?

Run npx skillmds@latest add lorem-dev/check-docs in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Check Docs safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Check Docs?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Check Docs free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Check Docs?

lorem-dev (@lorem-dev) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Check Docs by lorem-dev — Agent Skill

Name: Check Docs
Author: lorem-dev

File contents

check-docs

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

Steps

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.
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.
Check docs/ navigation. Open mkdocs.yml and verify:
- Every file listed under nav: exists under docs/.
- No nav entry points to a missing file.
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.
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.
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.
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.

---name: check-docsdescription: 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.---# check-docsVerify that all project documentation is accurate and up to date.## Steps1. **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.

Frequently asked questions

Check Docs