docs_sync_check

A documentation consistency check for an application. It compares visible text and guided-tour steps in the code with the help pages, about page, README, and tutorial.

In plain words
What is it for?
Use it to audit user-facing labels, help instructions, feature summaries, README content, and guided-tour steps for drift.
Why use it?
It finds places where documentation still describes renamed, removed, or changed controls. This helps prevent broken tutorials and confusing instructions.

Command for Claude Code

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/osiris-devworks/smart-citizen/docs_sync_check
Clone the repo
git clone --depth 1 https://github.com/Osiris-DevWorks/smart-citizen

Made for: Claude Code.

Per session 19 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 804 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.00019 $0.00804
Opus 5 $0.00010 $0.00402
Sonnet 5 $0.00004 $0.00161
Haiku 4.5 $0.00002 $0.00080

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

Security

Grade A, and why

docs_sync_check 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.

.claude/commands/docs_sync_check.md · 52 lines

How it starts

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

/docs_sync_check

Cross-check the running app's user-facing surface against the docs and tutorial. Catches drift introduced when a button is renamed in code but the doc still describes the old name, when a control is removed but the tutorial still points at it, or when a new feature ships without a docs update.

Severities

  • Critical — a tutorial step in src/gui/coach_mark.py references a widget that no longer exists. Will crash or confuse first-time users.
  • Major — workflow steps in docs/HELP.md no longer match the code, or a user-facing string is described in docs/HELP.md / docs/ABOUT.md under a name that no longer exists in code.
  • Minor — a feature mentioned in docs/ABOUT.md or README.md has been removed/renamed but isn't user-facing-critical (e.g. a string label drift that still reads naturally).

Inputs

  • src/gui/*.py — user-facing strings (window titles, button/menu/tab labels, dialog text, log lines users see in the Log Tab).
  • docs/HELP.md — step-by-step user instructions.
  • docs/ABOUT.md — feature summary.
  • src/gui/coach_mark.pyCoachMarkStep entries that drive the guided tour.
  • README.md — Features section and Screenshots labels.

Checks

  1. Tutorial widget validity (Critical): every CoachMarkStep in coach_mark.py references a target widget — confirm the widget still exists (grep for its attribute name on MainWindow and the relevant tabs). Flag any step whose target was deleted or renamed.
  2. String drift in HELP/ABOUT (Major): pull every user-facing literal from src/gui/ and check whether any noun phrase used in HELP.md or ABOUT.md is no longer present in the code (likely renamed). Flag with the doc file:line plus the suspected new wording from the code.
  3. Workflow currency (Major): HELP.md describes Apply / Restore / Extract / Reset user.ini / Export Loc-Pack / channel switch. If a recent diff changed any of these flows, surface the matching section of HELP.md for review.
  4. Feature parity (Minor, escalate to Major if HELP.md has a how-to step for the affected feature): HELP.md, ABOUT.md, and README's Features list should match the code. Flag features described in docs that no longer exist, and code features that aren't surfaced in any of the three.

Read the full file on GitHub · 52 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 · 52 lines · 19 tokens per session scan A edc0eeaa50d2

Subscribe to this mod's changes

docs_sync_check is a command published in the GitHub repository Osiris-DevWorks/smart-citizen (99 stars, last pushed 3d ago), licensed Apache-2.0. It adds 19 tokens to every session and 804 once invoked, about $0.0001 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-30.