webjs-doc-sync

A documentation-maintenance guide for changes that affect users or agents. It maps each kind of change to the project documentation files that may need updating, such as the main guide, website docs, and agent instructions.

In plain words
What is it for?
Use it when shipping a new option, export, convention, hook, or behavior change, or when checking for documentation drift. It helps decide which documentation surfaces to update or consciously skip.
Why use it?
It prevents documentation from being updated in only one place while other copies become outdated. This keeps the documented behavior consistent across the project.

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

Made for: Claude Code, Codex.

Per session 160 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,215 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.00160 $0.02215
Opus 5 $0.00080 $0.01107
Sonnet 5 $0.00032 $0.00443
Haiku 4.5 $0.00016 $0.00221

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

Security

Grade A, and why

webjs-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/skills/webjs-doc-sync/SKILL.md · 137 lines

How it starts

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

Keep every webjs doc surface in sync with shipped behaviour

WebJs ships its documentation across SEVERAL independent surfaces. The recurring failure mode is updating ONE (usually AGENTS.md) and silently missing the rest, so the docs site, the marketing website, and the scaffold's per-agent rule files drift behind the framework. HTTP-verb server actions (#488) shipped with AGENTS.md updated but the docs site untouched, which is exactly the gap this skill exists to close.

This skill is the authoritative map of every surface plus a deterministic change-type to surface mapping. Use it in two modes: per-change sync (a feature just shipped, bring docs in line) and audit (sweep already-shipped work for drift and file follow-ups).

The complete doc surface map

Treat this list as the universe. For any change, decide per surface whether it applies, then update or consciously skip each.

  1. AGENTS.md (repo root) plus the skill at .agents/skills/webjs/ (SKILL.md plus its 13 references/: routing-and-pages, components, data-and-actions, auth-and-sessions, styling, client-router-and-streaming, optimistic-ui, typescript, testing, built-ins, runtime, service-worker, muscle-memory-gotchas). AGENTS.md stays lean and points at the matching references/<x>.md for the full reference. A new public API goes in BOTH the AGENTS.md summary and the relevant references/ file.
  2. README.md (repo root). Update when a headline capability changes (the feature list, the quickstart, the runtime/template matrix).
  3. The docs site: website/app/docs/<topic>/page.ts. This is the user-facing documentation at webjs.dev/docs. Find the topic page(s) that cover the area (server-actions, routing, components, caching, configuration, client-router, data-fetching, ...) and update them. llms.txt / llms-full.txt are generated LIVE from the doc pages (no build step), so they never need a manual edit. A brand-new capability may need a NEW topic page plus a nav entry.
  4. The marketing website: website/. Update landing/feature copy when a headline capability changes. The changelog (website/app/changelog) is auto-generated from conventional PR titles, so NEVER hand-write it; the blog is manual.
  5. The scaffold templates: packages/cli/templates/. Every new app ships these. The scaffold is single-source: AGENTS.md (a thin pointer) plus the one cross-agent skill at .agents/skills/webjs/ (SKILL.md + references/) that every tool reads. There are no per-agent rule files to keep in lockstep. A change to how apps are AUTHORED lands in the skill. When the change is to what webjs create GENERATES (a gallery/showcase demo, a template, the generated layout/home/theme/schema, a scaffold convention), this surface has more parts (the packages/cli/lib/* generators, the repo-root gallery/** app whose demos prepack bundles into the CLI, the scaffold tests, the framework template-matrix docs, the preview apps) and a mandatory generate + boot + webjs check step: use the dedicated webjs-scaffold-sync skill for those, and treat this doc-sync entry as the docs-only slice. The CLI help text in packages/cli/ is part of this surface for a new command or flag.
  6. Example / dogfood apps (examples/blog/CONVENTIONS.md and friends). Update when a convention the example demonstrates changes.

Read the full file on GitHub · 137 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 · 137 lines · 160 tokens per session scan A 26897e1c63a9

Subscribe to this mod's changes

webjs-doc-sync is a skill published in the GitHub repository webjsdev/webjs (109 stars, last pushed 10d ago), licensed MIT. It adds 160 tokens to every session and 2,215 once invoked, about $0.0008 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