agentleFS
RemiMyrsetRemiMyrset/roots/.agents/skills/verify-docs/SKILL.md

verify-docs

Skill0 starsChanged 41 days agoMITView on GitHub

Run the full docs gate locally and fix what it finds. Generated-section drift, format violations, broken links, portability breaks. Use after any edit under docs/, README.md, or AGENTS.md, before committing docs changes, or when the user says 'check the docs' or 'verify docs'.

4 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 3 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run the docs steps of the done gate, in CI order, and fix failures at the source:

    line 8
  2. Very specific:

    If VitePress content or config changed, pnpm docs:internal:build and pnpm docs:public:build must both succeed.

    line 22

“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Verify docs

Run the docs steps of the done gate, in CI order, and fix failures at the source:

  1. pnpm docs:gen rewrites the .agents/skills mirror and any automd region a page keeps. Then git status --porcelain catches staged and untracked output, same as CI; if generated files changed, include the regenerated output in this change. Only when you made no docs edits does a change mean the previous commit had drift.
  2. pnpm docs:check enforces the couplings listed under "Generated vs hand-written" in docs/template/spec-discipline.md. Fix the document or the path, never loosen the checker.
  3. pnpm docs:portability enforces the rules in docs/template/markdown-portability.md. Fix violations per that page; never suppress.
  4. If VitePress content or config changed, pnpm docs:internal:build and pnpm docs:public:build must both succeed.

Report what was regenerated, what was fixed, and any remaining warnings (for example stale Last reviewed dates that need a human re-read). A stale date on a docs/template/ page is the template's to fix: in the template, re-verify the page and bump the date; in a child, never edit the page; report the warning and propose pnpm sync:template (the sync-template skill), which runs only when the user asks. For the full done gate (code and docs together), run pnpm verify instead.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.