sync-public-docs

A documentation-synchronisation skill for the public API of react-zmage, a React component package for displaying images. It identifies documentation and example files that can become outdated when public types, props, or defaults change.

In plain words
What is it for?
Updating public documentation after changing exported types, props, default values, package exports, or before publishing a new version. It covers README files, API docs, examples, and llms.txt.
Why use it?
It helps prevent the package code, documentation, examples, and generated reference files from disagreeing.

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/caldis/react-zmage/sync-public-docs
Any agent
npx skills add Caldis/react-zmage --skill sync-public-docs
Clone the repo
git clone --depth 1 https://github.com/Caldis/react-zmage

Made for: Claude Code, Codex.

Per session 203 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,396 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.00203 $0.03396
Opus 5 $0.00102 $0.01698
Sonnet 5 $0.00041 $0.00679
Haiku 4.5 $0.00020 $0.00340

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

Security

Grade A, and why

sync-public-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 3d 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.

.agents/skills/sync-public-docs/SKILL.md · 171 lines

How it starts

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

Sync public docs (react-zmage)

Why this skill exists

The repo has four "outward-facing" documentation surfaces and only two of them are guarded automatically:

Destination Source of truth Auto-guard?
packages/core/src/types/ itself — (this IS the source)
packages/home/src/schema/param-schema.ts imports BaseType from react-zmage (typed) but defaults are hand-copied ✅ types only; ❌ default values
packages/home/src/docs/sections/*.tsx + i18n keys hand-written prose
packages/home/src/playground/* + routes/playground/* hand-written examples
docs/llms.txt checked-in file served as /llms.txt ✅ static contract tests, ❌ content is still hand-written
packages/llms-eval/eval.test.mjs (11-item contract) llms.txt ↔ core ✅ but manual run only
README.md / AGENTS.md hand-written

When core's public API changes, drift across these surfaces is silent — TS will flag a renamed type symbol but won't flag a stale default value, an outdated prop description in Props.tsx, or a removed prop still mentioned in README.md.

The cost of drift is real: README is what npm shows; llms.txt is what AI agents read; home/docs is what the live site renders. They can each go wrong independently.

When to invoke

Strong triggers (just do it):

  • Any change to packages/core/src/types/global.ts, types/default.ts, or index.ts
  • Any change to packages/core/package.json exports field, peerDependencies, or version
  • Adding, renaming, or removing a prop on <Zmage>
  • Changing a default value in defProp or defPreset
  • Changing the static method surface of Zmage (e.g. adding a new Zmage.X)
  • Changing what react-zmage/ssr exports
  • The user says "sync docs", "propagate this", "update public docs", "同步文档", "准备发版"

Weak triggers (consider, then judge):

  • Pure internal refactors that don't change public types or defaults — usually skip
  • Documentation-only PRs that already touch one destination — still run steps 5–6 to verify the others didn't drift
  • Tooling/build config changes — only if they alter exports, peerDeps, or what consumers see

Read the full file on GitHub · 171 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. 3d ago First seen · 171 lines · 203 tokens per session scan A b55ae7d49707

Subscribe to this mod's changes

sync-public-docs is a skill published in the GitHub repository Caldis/react-zmage (943 stars, last pushed 3mo ago), licensed MIT. It adds 203 tokens to every session and 3,396 once invoked, about $0.0010 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

chakra-ui-builder

Build responsive, accessible UI components and layouts using Chakra UI v3, install or configure Chakra UI in new and existing projects, and design scalable themes using tokens, semantic tokens, recipes, and slot recipes. Use this skill whenever a user asks to build, create, or generate any UI component, page, form…

chakra-ui/chakra-ui · 214 tokens

row-selection

Maintain rowSelection ID state with stable getRowId, single, multi, subrow, and Shift-range rules, selected row models, handler anchors, and manual-pagination semantics. Load when implementing getToggleSelectedHandler, enableRowRangeSelection, selectChildren, deselectParents, or selected IDs that outlive loaded Row…

TanStack/table · 68 tokens

material-ui-tailwind

Integrates Material UI with Tailwind CSS v4 using cascade layers (enableCssLayer, @layer order) and documents Tailwind v3 interoperability (preflight, important, injectFirst, portals). Use when combining MUI with Tailwind utilities, slotProps className, or theme token bridges.

mui/material-ui · 67 tokens

r3f-best-practices

React Three Fiber (R3F) and Poimandres ecosystem best practices. Use when writing, reviewing, or optimizing R3F code. Triggers on tasks involving @react-three/fiber, @react-three/drei, zustand, @react-three/postprocessing, @react-three/rapier, or leva.

zebbern/claude-code-guide · 74 tokens

wrdn-effect-promise-exit

Replace React/effect-atom mutation handlers that use promise-mode plus try/catch with promiseExit and explicit Exit handling. Use when lint or review flags try/catch around useAtomSet mutation calls, especially UI handlers that set error/busy state after a failed mutation.

UsefulSoftwareCo/executor · 63 tokens

assistant-ui-primitives

Guide for assistant-ui UI primitives - ThreadPrimitive, ComposerPrimitive, MessagePrimitive. Use when customizing chat UI components.

compozy/compozy · 28 tokens