sync-doc

A documentation-maintenance guide for the public parts of the @qalma/editor library and its apps/docs site. It compares code changes with the documentation and updates only what users of the library can observe.

In plain words
What is it for?
Checking whether a library change needs documentation updates and keeping the relevant pages aligned with the public API.
Why use it?
It prevents documentation from becoming inaccurate after public exports, options, component inputs, outputs, selectors, or behaviour change.

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/cdskill/qalma/sync-doc
Any agent
npx skills add cdskill/qalma --skill sync-doc
Clone the repo
git clone --depth 1 https://github.com/cdskill/qalma

Made for: Claude Code, Codex.

Per session 74 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,163 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.00074 $0.01163
Opus 5 $0.00037 $0.00581
Sonnet 5 $0.00015 $0.00233
Haiku 4.5 $0.00007 $0.00116

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

Security

Grade A, and why

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

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/detect-doc-impact.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.

.claude/skills/sync-doc/SKILL.md · 100 lines

How it starts

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

sync-doc

Garde la doc apps/docs alignée sur le contrat public de @qalma/editor (libs/editor). Le but n'est PAS de re-documenter à chaque commit, mais de détecter quand un changement de code rend la doc fausse ou incomplète, et de corriger uniquement ce qui le nécessite.

Principe directeur

Ne synchronise que si le changement touche le contrat public documenté :

Doc-pertinent (→ sync) Non doc-pertinent (→ ignorer)
Export ajouté/supprimé/renommé dans index.ts Helper privé, fonction non exportée
Signature publique modifiée (params, type de retour, options) Refacto interne à contrat identique
@Input / @Output / sélecteur de composant changé Tests (*.spec.ts), fixtures
Valeur par défaut / option publique d'un plugin changée Commentaires, formatage, renommage interne
Comportement décrit par une page de doc qui change Perf/optimisation sans impact d'API

En cas de doute : un changement est doc-pertinent uniquement s'il est observable par un consommateur qui n'importe que depuis @qalma/editor.

Ancrages du repo

  • Surface publique : libs/editor/src/index.ts (re-exporte les plugins, l'éditeur, la toolbar, les commandes). C'est la source de vérité du contrat.
  • Doc : apps/docs/src — pages Analog (src/app/pages/**) et, à terme, contenu markdown (src/content/** / pages .md).
  • Package documenté : @qalma/editor.

Workflow

1. Déterminer le set de changements

Argument optionnel : une plage git ($1, ex. main...HEAD, HEAD~3). Par défaut : working tree (non commité), sinon HEAD~1.

Lance le détecteur d'impact :

bash .claude/skills/sync-doc/scripts/detect-doc-impact.sh "$ARGS"

Il liste, parmi les fichiers changés sous libs/editor/src :

  • ceux qui touchent un module exporté depuis index.ts (→ candidats sync) ;
  • pour chaque symbole concerné, les pages de doc qui le mentionnent ;
  • les exports sans page de doc (→ doc manquante à créer).

Read the full file on GitHub · 100 lines

Files

What ships with it

1 file 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. 2d ago First seen · 100 lines · 74 tokens per session scan A 6b717ede6035

Subscribe to this mod's changes

sync-doc is a skill published in the GitHub repository cdskill/qalma (10 stars, last pushed 1mo ago), licensed MIT. It adds 74 tokens to every session and 1,163 once invoked, about $0.0004 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 skills, from other repositories

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

heap-snapshot-analysis

Analyze V8 heap snapshots to investigate memory leaks and retention issues. Use when given .heapsnapshot files, asked to compare before/after snapshots, asked to find what retains objects, or investigating why objects survive GC. Provides snapshot parsing, comparison, retainer-path helpers, and scratchpad scripts.

microsoft/vscode · 65 tokens

integrated-browser

Use this when working on the VS Code integrated browser ("browserView") to understand its architecture and mental model. Covers the embedded Chromium browser, its editor tab, navigation, overlay/layout, sessions, and agent browser tools under src/vs/platform/browserView and src/vs/workbench/contrib/browserView.

microsoft/vscode · 68 tokens

tool-rename-deprecation

Ensure renamed built-in tool references preserve backward compatibility. Use when renaming a toolReferenceName, tool set referenceName, or any tool identifier. Run on ANY change to tool registration code. Covers legacyToolReferenceFullNames for tools and legacyFullNames for tool sets.

microsoft/vscode · 60 tokens

agent-host-e2e-tests

Use when writing, recording, updating, or troubleshooting the agent host end-to-end tests under src/vs/platform/agentHost/test/node/e2e (black-box tests that drive the whole agent host over the AHP protocol, using a CapiReplayProxy record/replay system for Claude/Copilot/Codex). Covers adding a cross-provider test…

microsoft/vscode · 104 tokens

fix-errors

Guidelines for fixing unhandled errors from the VS Code error telemetry dashboard. Use when investigating error-telemetry issues with stack traces, error messages, and hit/user counts. Covers tracing data flow through call stacks, identifying producers of invalid data vs. consumers that crash, enriching error messages…

microsoft/vscode · 75 tokens