doc-update

A command for bringing project documentation back in line with the code, settings, command-line options, versions, and links that currently exist.

In plain words
What is it for?
Use it to update API references, configuration instructions, CLI usage, version notes, feature descriptions, and links in a chosen document or across the project.
Why use it?
Documentation becomes misleading when the code changes but the written instructions do not. It helps find and correct those differences, including outdated links and deprecated features.

Command

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/zircote-plugins/documentation-review/doc-update
Clone the repo
git clone --depth 1 https://github.com/zircote-plugins/documentation-review
Per session 9 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 761 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00009 $0.00761
Opus 5 $0.00005 $0.00380
Sonnet 5 $0.00002 $0.00152
Haiku 4.5 $0.00001 $0.00076

Measured 2d ago against content hash bab849f0fc32, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

doc-update scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

commands/doc-update.md · 149 lines

How it starts

The opening of the file, as written. The whole thing — 149 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Update documentation to reflect current codebase state.

Target Scope

$IF($1, Update: @$1, Identify all outdated documentation in project )

Update Process

1. Detect Outdated Content

Code-Documentation Drift

  • Compare documented APIs with actual implementation
  • Check documented configuration options against code
  • Verify documented dependencies against package files
  • Compare documented CLI options with actual help output

Version Drift

  • Find version numbers in documentation
  • Compare against current releases
  • Identify deprecated features still documented
  • Find new features not yet documented

Link Rot

  • Check internal links resolve to existing files
  • Validate anchor links
  • Test external links for accessibility

2. Gather Current State

For code drift:

# Get actual function signatures
# Get current configuration schema
# Get current CLI help

Use Grep and Read to:

  • Extract current function signatures
  • Read configuration schemas
  • Parse CLI help output
  • Find actual API endpoints

3. Update Categories

API Changes

  • Update function signatures
  • Add new parameters
  • Remove deprecated options
  • Update return types

Configuration Changes

  • Add new config options
  • Update default values
  • Mark deprecated options
  • Update environment variables

Dependency Changes

  • Update version requirements
  • Add new dependencies
  • Remove deprecated ones
  • Update installation commands

Feature Changes

  • Document new features
  • Update changed behaviors
  • Mark deprecated features
  • Add migration notes

4. Diátaxis Drift Check (enabled by default; disable with diataxis.enabled: false)

Before applying changes, check for quadrant drift:

  • Read the document's diataxis_type from frontmatter (or classify if missing)
  • Evaluate whether the proposed changes introduce content from a different quadrant
  • Flag drift: "This addition is [explanation/reference] content being added to a [tutorial/how-to]"
  • Suggest extraction: recommend creating a separate document in the correct quadrant
  • Use the diataxis skill for classification compass and mode mixing detection

Read the full file on GitHub · 149 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 149 lines · 9 tokens per session scan A bab849f0fc32

Subscribe to this mod's changes

doc-update is a command published in the GitHub repository zircote-plugins/documentation-review (5 stars, last pushed 2mo ago), licensed MIT. It adds 9 tokens to every session and 761 once invoked, about $0.0000 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other commands, from other repositories

capture-answer

Ingests an expert's answers to an L2 questionnaire in the abapwiki knowledge base: transforms the answers (filled in the interviews/ file or given verbally) into a canonical citable expert-answer (slices/ /inputs/expert-answers/), moves gaps to 'answered' and closes the questions. Use this skill when the owner/expert…

Gixsy95/abap_wiki · 85 tokens

ingest-l1

L1 analysis loop for the abapwiki knowledge base: for each batch it launches the abap-analyzer sub-agent in parallel, then the adversarial judge abap-deepcheck (separate session), applies only the analyses that pass the fail-closed gate, and commits. Resumes exactly after an interruption. Use this skill to document…

Gixsy95/abap_wiki · 86 tokens

research-l2

Executes Phases 1-3 of the L2 process of the abapwiki knowledge base on a slice: launches the abap-functional-researcher sub-agent (gap discovery + multi-source auto-research: wiki -> raw/docs -> MCP abap-fs on the system read-only -> standard knowledge), ingests gaps and evidence, and generates questionnaires for…

Gixsy95/abap_wiki · 111 tokens

slice-init

Creates an L2 slice in the abapwiki knowledge base: a business process on which to build functional documentation. Writes the manifest (curated anchors + mandatory real owner) and derives the membership from the dependency graph (BFS hop<=2). Use this skill to start the L2 process on a custom domain. Does not promote…

Gixsy95/abap_wiki · 83 tokens

ingest-l0

L0 bootstrap of the abapwiki knowledge base: creates stubs for all custom objects from the TADIR. Use this skill to initialize the repo from scratch or to ingest a new TADIR export. Deterministic operations (no LLM sub-agent), idempotent.

Gixsy95/abap_wiki · 59 tokens

lint-audit

Checks the integrity of the abapwiki knowledge base: parseable YAML frontmatter, no broken wikilinks, resolvable [VERIFIED: path:N-M] citations, non-nested confidence tags, drift between wiki and DB, synchronization between canonical agent contracts and the .claude/agents/ copies. Use this skill periodically or after…

Gixsy95/abap_wiki · 74 tokens