canonical-doc-sync

canonical-doc-sync is a skill for Codex from Eliyce/paqad-ai. It costs 13 tokens per session (535 once invoked), scanned A, original, MIT.

A documentation helper that updates the project’s authoritative specifications, module documents, and registries to match implementation changes.

In plain words
What is it for?
Use it after code changes, especially when several documentation surfaces must be updated together.
Why use it?
It reduces drift between the code that was shipped and the documentation developers rely on.

Skill for Codex

Written for Codex: agents/openai.yaml present.

Good fit Use it after code changes, especially when several documentation surfaces must be updated together.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/eliyce/paqad-ai/canonical-doc-sync
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.

Any agent
npx skills add Eliyce/paqad-ai --skill canonical-doc-sync
Clone the repo
git clone --depth 1 https://github.com/Eliyce/paqad-ai

Made for: Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for canonical-doc-sync

README.md
[![agentmods](https://agentmods.dev/badge/skills/eliyce/paqad-ai/canonical-doc-sync/github.svg)](https://agentmods.dev/skills/eliyce/paqad-ai/canonical-doc-sync)
Your own site
<a href="https://agentmods.dev/skills/eliyce/paqad-ai/canonical-doc-sync"><img src="https://agentmods.dev/badge/skills/eliyce/paqad-ai/canonical-doc-sync/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for canonical-doc-sync

Your own site · 80×15
<a href="https://agentmods.dev/skills/eliyce/paqad-ai/canonical-doc-sync"><img src="https://agentmods.dev/badge/skills/eliyce/paqad-ai/canonical-doc-sync.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 13 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 535 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00013 $0.00535
Opus 5 $0.00006 $0.00267
Sonnet 5 $0.00003 $0.00107
Haiku 4.5 $0.00001 $0.00053

Measured 11d ago against content hash d58596fe5ef6, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

canonical-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 11d ago.

The scan reads SKILL.md. This mod also ships 2 executable files (scripts/lint-output.sh, scripts/list-canonical-docs.sh), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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.

runtime/base/skills/canonical-doc-sync/SKILL.md · 68 lines

What it actually says

What It Does

Updates canonical project documentation after implementation changes so specs, module docs, and registries remain aligned with the actual behavior that shipped or is about to ship.

Use This When

Use this after code changes are understood and before handoff closes, especially when multiple doc surfaces must be updated together to avoid drift.

Inputs

  • Read the changed files, existing canonical docs, and any generated inventories for the affected area.
  • Read the module docs and global registries that should reflect the change.
  • Read references/drift-triage.md before deciding what to update immediately versus defer explicitly.

Procedure

  1. Run scripts/list-canonical-docs.sh to enumerate the canonical doc surfaces that exist in this project.
  2. Identify which of those are now stale relative to the implementation change.
  3. Update behavior docs, module docs, and registries together — never patch only one surface.
  4. Prefer generated inventories or script output for routes, events, and error codes when available.
  5. Format per assets/output.template.md and validate with scripts/lint-output.sh.

Output Contract

  • Match assets/output.template.md: ## Updated Docs (backticked .md paths + summary) and ## Known Drift (backticked paths + reason, or the literal none).
  • Output must pass scripts/lint-output.sh (exit 0).

Escalate / Stop Conditions

  • Ask when docs disagree with implementation and the product decision is unclear.
  • Warn when generated sources are missing and a manual sync would be speculative.
  • Do not silently skip a stale canonical doc that is still user-facing or operationally important.

Resources

  • references/drift-triage.md
  • scripts/list-canonical-docs.sh
  • scripts/lint-output.sh
  • assets/output.template.md
  • runtime/templates/runner-scripts/extract-events.sh.hbs
  • agents/openai.yaml
Files

What ships with it

5 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 11d ago First seen · 68 lines · 13 tokens per session scan A d58596fe5ef6

Subscribe to this mod's changes

canonical-doc-sync is a skill published in the GitHub repository Eliyce/paqad-ai (8 stars, last pushed today), licensed MIT. It adds 13 tokens to every session and 535 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-31.