agentleFS
Harry-kpHarry-kp/vortix/.claude/skills/docs-review/SKILL.md

docs-review

Skill757 starsChanged 49 days agoMITView on GitHub

Check a vortix diff for documentation it makes wrong or leaves missing, and fix the docs in the same change. Mandatory before every commit in this repo, right after ponytail-review, and part of fix-bug and release-qa. Use it whenever code, CLI flags, keys, TUI text, settings, errors, CI or scripts change, even if the user did not mention docs.

26 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use code-review.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 25 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run git diff origin/main --stat and read the diff.

    line 23
  2. Very specific:

    Upgrade impact: if an existing user must act, docs/MIGRATION.md and whats_new.rs (see the release-changelog skill).

    line 35
  3. Distinctive:

    Every sentence must be true of the code on this branch: grep before you write.

    line 40
  4. Very specific:

    Add the doc edits to the same commit as the code.

    line 49

“Common” is measured: kept by at least 6 in 10 of the 25 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

Docs review

The docs are read mostly by agents, who act on them without checking. A doc that is out of date is worse than a missing one. This review keeps the docs true of the diff being committed, so the fix goes in the same commit.

1. Run the mechanical check

cargo xtask check-docs && cargo test -p vortix --test suite docs_match_code

The first covers links and anchors; the second, the subcommands and flags in docs/usage.md and the config keys in docs/configuration.md. Fix every failure before going on.

2. Map the diff to its owners

Run git diff origin/main --stat and read the diff. For each changed surface, open its owner in CLAUDE.md's "Docs" table and read the section it touches. Look for:

  • Renamed or removed things: rg the old name in every *.md, .claude/skills/ and the help strings in code (HELP_TEXT, clap about/after_help, Hints). Update or delete each hit.
  • Changed behaviour: defaults, timeouts, limits, exit codes, JSON fields, error text, which OS a feature supports. Update the sentence that states the old behaviour; the check in step 1 does not read meaning.
  • New things a user can hit: a flag, key, setting or error needs a line in its owner. An error message a user must act on also gets a troubleshooting entry.
  • Moved code: paths in CLAUDE.md's "Where things live", the skills and docs/ci-parity.md.
  • Upgrade impact: if an existing user must act, docs/MIGRATION.md and whats_new.rs (see the release-changelog skill).

3. Write like the existing docs

  • Every sentence must be true of the code on this branch: grep before you write. A doc claim copied from a PR body or a comment is a guess.
  • One owner per fact. Link to its heading instead of restating it; a second copy drifts.
  • Describe what the program does now. No history ("used to", "since 0.4"), plan IDs, phase names or roadmap promises, except in MIGRATION.md and the changelog.
  • Short, plain sentences; tables for lists of keys, flags or options.

4. Report

Add the doc edits to the same commit as the code. Then give one line per file changed, or Docs match the diff. if nothing needed changing. If a doc change needs a product decision (for example, whether to document a hidden flag), ask rather than guessing.

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.