update-docs

A documentation update workflow for projects whose code changes affect user-facing instructions. It checks changes and updates README.md, README_ZH.md, and, when present, KNOWLEDGE_BASE.md.

In plain words
What is it for?
Use it after adding adapters, changing CLI commands or configuration, or making other user-facing changes. It also runs tests and checks that documented commands still work.
Why use it?
It reduces the risk that documentation describes old commands, features, configuration, or examples. It also helps keep English and Chinese README files aligned.

Skill for Claude CodeCodex

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 skills/lbb00/ai-rules-sync/update-docs
Any agent
npx skills add lbb00/ai-rules-sync --skill update-docs
Clone the repo
git clone --depth 1 https://github.com/lbb00/ai-rules-sync

Made for: Claude Code, Codex.

Per session 12 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 298 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.00012 $0.00298
Opus 5 $0.00006 $0.00149
Sonnet 5 $0.00002 $0.00060
Haiku 4.5 $0.00001 $0.00030

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

Security

Grade A, and why

update-docs 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/skills/update-docs/SKILL.md · 55 lines

What it actually says

Update Documentation

Instructions

One-click command to update all project documentation after code changes.

Steps

  1. Analyze Changes

    • Check git status for modified files
    • Review recent commits if no uncommitted changes
    • Identify what documentation needs updating
  2. Update KNOWLEDGE_BASE.md

    • Run the update-knowledge-base skill
    • Document any architectural or feature changes
  3. Update README.md

    • Add new features or commands
    • Update examples if API changed
    • Ensure accuracy of all documented commands
  4. Sync README_ZH.md

    • Run the sync-readme skill
    • Ensure Chinese documentation matches English
  5. Verify

    • Run tests to ensure nothing broken: npm test
    • Check that all documented commands work
    • Review diff before committing

When to Use

  • After adding a new adapter
  • After adding or modifying CLI commands
  • After changing the configuration format
  • After any user-facing changes

Output

All documentation files updated and in sync:

  • KNOWLEDGE_BASE.md (if exists)
  • README.md
  • README_ZH.md

Examples

Request: Update all docs after adding OpenCode support Result: KNOWLEDGE_BASE.md, README.md, and README_ZH.md all updated

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 · 55 lines · 12 tokens per session scan A de6a9ff467d0

Subscribe to this mod's changes

update-docs is a skill published in the GitHub repository lbb00/ai-rules-sync (37 stars, last pushed 13d ago), licensed Unlicense. It adds 12 tokens to every session and 298 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.

Related

Other skills, from other repositories

authoring-skills-and-rules

Author Skills (SKILL.md) and rules/instructions across Claude Code, Cursor, OpenCode, Codex, and GitHub Copilot. Covers frontmatter, file layout, activation model, cross-platform mirroring, and the universal craft: progressive disclosure, trigger-rich descriptions (context pointers), leading words, token budget…

afaraha8403/balakit · 132 tokens

karpathy-guidelines

Tool-agnostic behavioral guidelines for AI coding assistants. Use when writing, reviewing, debugging, or refactoring code to reduce overengineering, surface ambiguity, make surgical changes, and define verifiable success criteria.

Vincent-A-Yang/karpathy-skills-anycoding · 47 tokens

spec-driven

Structured planning pipeline with 4 adaptive phases (Specify, Design, Tasks, Execute) and persistent knowledge accumulation for development teams. Auto-sizes depth by complexity from quick fixes to multi-component features. Commands: /explore (understand problem + map context), /plan (write spec → design → tasks)…

90sRehem/agent-skills · 241 tokens

skill-memory

Use skill-memory to download, view and edit agent skills in memory. TRIGGER by 'skill', 'memory', 'learn'.

memodb-io/skill-memory · 29 tokens

valyu-best-practices

Complete Valyu API toolkit for AI agents. Use this skill when asked to perform real-time search across web, academic, medical, transportation, financial sources, content extraction from URLs, AI-powered answers with citations, or comprehensive deep research reports.

valyuAI/skills · 55 tokens

idea-refine

Refines raw ideas into sharp, actionable concepts through structured divergent and convergent thinking. Use when an idea is still vague, when you need to stress-test assumptions before committing to a plan, or when you want to expand options before converging on one. Triggers on "ideate", "refine this idea", or…

addyosmani/agent-skills · 75 tokens