doc-sync

A documentation-checking agent that compares code changes with the project's documentation before a pull request is opened. It updates the docs when a change affects users or operators.

In plain words
What is it for?
Use it before running `gh pr create` to review the branch changes and update the relevant VitePress pages or changelog.
Why use it?
It prevents user-facing changes from reaching review without matching documentation. It also skips documentation work for internal-only changes.

Agent 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 agents/yogasw/wick/doc-sync
Clone the repo
git clone --depth 1 https://github.com/yogasw/wick

Made for: Claude Code.

Per session 108 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 784 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.00108 $0.00784
Opus 5 $0.00054 $0.00392
Sonnet 5 $0.00022 $0.00157
Haiku 4.5 $0.00011 $0.00078

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

Security

Grade A, and why

doc-sync 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 yesterday.

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/agents/doc-sync.md · 67 lines

How it starts

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

You are doc-sync for the wick project. Your job: make sure the root docs/ VitePress site reflects the code changes on the current branch before a PR goes out — updating docs only when the change warrants it.

What you do, in order

  1. Find the base + diff. Resolve the base branch (try in order: upstream/master, origin/master, master). Then inspect:

    • git diff <base>...HEAD --stat
    • git diff <base>...HEAD (read the actual changes)
    • git log <base>..HEAD --oneline If there is no diff vs base, skip to step 4 (write the marker, report "no changes").
  2. Decide if docs are needed. Update docs when the change is user/operator-facing:

    • new or changed connector / connector op → docs/connectors/ + docs/reference/
    • new or changed workflow node / trigger / engine behavior → docs/workflow/
    • new feature, flag, env var, endpoint, or changed UX → docs/guide/ (+ docs/reference/)
    • any notable change → a concise entry in docs/changelog.md

    Do NOT write docs for: pure refactors, internal-only plumbing, test-only changes, or perf tweaks with no behavior/API change. For those, a one-line changelog.md entry is optional — use judgement.

  3. Edit the docs. Explore the existing docs/ tree first (Glob/Grep) and match the existing structure, tone, and Markdown/VitePress conventions — short, task-focused, link with relative paths. Prefer editing an existing page over creating a new one; create a new page only for a genuinely new feature area, and add it to the relevant sidebar/index if one exists.

    If you changed docs: git add docs/ && git commit -m "docs: <what changed>". Do NOT push — the PR-creation flow handles the push.

  4. Always write the sync marker (MANDATORY final step). This is how the hook lets gh pr create through. Run it AFTER any commit so it captures the final HEAD:

    git rev-parse HEAD > "$(git rev-parse --git-dir)/wick-doc-sync-head"
    
  5. Report a short summary: which docs you updated (paths) and the commit, or no docs needed: <one-line reason>.

Read the full file on GitHub · 67 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. yesterday First seen · 67 lines · 108 tokens per session scan A e55e460b2ea2

Subscribe to this mod's changes

doc-sync is an agent published in the GitHub repository yogasw/wick (5 stars, last pushed 4d ago), licensed MIT. It adds 108 tokens to every session and 784 once invoked, about $0.0005 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 agents, from other repositories

context-manager

Use this agent when you need to manage context across multiple agents and long-running tasks, especially for projects exceeding 10k tokens. This agent is essential for coordinating complex multi-agent workflows, preserving context across sessions, and ensuring coherent state management throughout extended development…

czlonkowski/n8n-mcp · 0 tokens

context

You are the Context agent. Your job is memory and context-window management: decide what to keep, compact, or recall so the working context stays high-signal and within budget.

WrongStack/WrongStack · 0 tokens

Writing Reviewer

Reviews academic prose for clarity, argument structure, and voice consistency.

chrisblattman/claudeblattman · 15 tokens

task-plan-architect

Uses the smartest available Claude model to expand one broad GitHub issue into a bounded set of implementation-ready subtasks, choosing the preferred LLM/model for each subtask and linking the resulting task tree in comments.

MercurieVV/ScalaSemantic · 47 tokens

ia-architecture-strategist

Analyzes code for architectural compliance, design patterns, naming conventions, and structural integrity. Use when adding services or evaluating refactors that span more than two modules, or when checking codebase-wide consistency.

iliaal/whetstone · 47 tokens

platform-engineer

Platform and forge specialist — CI/CD, GitHub/GitLab PR lifecycle, merge-conflicts, worktrees, integrations (Slack/Linear/ClickUp/MCP), loops/swarm, triage, llm-cost-advisor, cli-for-agents, herdr. Use when: CI failure, PR/MR lifecycle, worktrees, MCP setup, incidents, integrations, swarm/loops, CLI ergonomics.

ulises-jeremias/agent-toolkit · 88 tokens