js-docs-sync

A documentation synchronisation workflow for JavaScript packages that contain a docs/ folder. It compares the package's hand-written documentation with its source code and public API.

In plain words
What is it for?
Use it after changing JavaScript package source files to identify the right documentation, inspect exports and source maps, and update the affected docs.
Why use it?
It helps prevent documentation from describing missing exports, outdated function signatures, or examples that no longer work.

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/arize-ai/openinference/js-docs-sync
Any agent
npx skills add Arize-ai/openinference --skill js-docs-sync
Clone the repo
git clone --depth 1 https://github.com/Arize-ai/openinference

Made for: Claude Code, Codex.

Per session 135 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,393 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.00135 $0.01393
Opus 5 $0.00068 $0.00696
Sonnet 5 $0.00027 $0.00279
Haiku 4.5 $0.00014 $0.00139

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

Security

Grade A, and why

js-docs-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 2d 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/js-docs-sync/SKILL.md · 152 lines

How it starts

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

JS Package Docs Sync

Verify and update hand-written docs/ documentation in a JS package so it stays accurate against the actual source code. These docs ship in the npm package (via the files field in package.json) for coding agents to read from node_modules.

When This Matters

The docs are the contract between the package and coding agents that consume it. Stale signatures, missing exports, or invalid examples mean agents write broken code. Source code is the single source of truth — docs must reflect it exactly.

Workflow

Step 1: Identify the Package

Determine which JS package to sync. If not clear from context, check which packages have a docs/ directory:

find js/packages -maxdepth 2 -name docs -type d

If only one package has docs, use it. Otherwise ask the user.

Step 2: Understand the Doc Structure

Read docs/README.md in the target package. It contains:

  • A Documentation Guide table mapping each doc file to its topic area
  • An All Exports at a Glance section listing every public export
  • A Source Code Map showing which source files contain what

This is your roadmap — it tells you what each doc file covers and where to look in the source to verify it.

Step 3: Identify What Changed

If this is triggered by source edits, focus on the changed files:

git diff --name-only HEAD~1 -- js/packages/<package>/src/

Map changed source files to the doc files that cover them (using the Source Code Map in README.md). You only need to re-verify the affected docs.

If this is a full review (user asks to "check all docs"), verify everything.

Step 4: Verify Each Doc File

For each doc file that needs checking, compare it against the source code. Check these things in order:

4a. Export Completeness

Read the barrel files (src/index.ts and any sub-module index.ts files) to get the full list of public exports. Compare against what's listed in docs/README.md under "All Exports at a Glance". Flag any export that is:

  • In source but missing from docs (new export, needs documenting)
  • In docs but not actually exported (removed or renamed, needs removing from docs)

Read the full file on GitHub · 152 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. 2d ago First seen · 152 lines · 135 tokens per session scan A 59dbf0117bdb

Subscribe to this mod's changes

js-docs-sync is a skill published in the GitHub repository Arize-ai/openinference (1,186 stars, last pushed 3d ago), licensed Apache-2.0. It adds 135 tokens to every session and 1,393 once invoked, about $0.0007 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

trulens-instrumentation

Instrument LLM apps with TruLens OTEL-based tracing - from setup to debugging and optimization.

truera/trulens · 25 tokens

frontmcp-observability

Use when adding tracing, structured logging, metrics, or monitoring to a FrontMCP server. Covers zero-config OpenTelemetry distributed tracing across all flows; the this.telemetry API for custom spans, events, and attributes in tools, plugins, agents, and skills; structured JSON logging with trace correlation and…

agentfront/frontmcp · 177 tokens

opentelemetry-net-instrumentation

Provides guidance for implementing OpenTelemetry instrumentation in .NET codebases, covering tracing (Activities/Spans), metrics, logs, naming conventions, error handling, performance, SDK setup, resources, context propagation, and API design best practices.

Aaronontheweb/dotnet-skills · 56 tokens

golang-observability-opentelemetry

Instrumenting Go applications with OpenTelemetry for distributed tracing, Prometheus for metrics, and structured logging with slog.

bobmatnyc/claude-mpm-skills · 31 tokens

debugging-with-wide-events

Use when investigating production behavior by querying wide events (a slow route, an error spike, a suspicious deploy, "why is this happening for account X"). Covers the data model, the symptom-to-query workflow, and standing queries worth running.

adammiribyan/wide_events · 54 tokens

setting-up-wide-events-store

Use when a human asks to set up, deploy, or finish deploying the bundled Wide Events DuckDB store (the Kamal accessory that receives production telemetry). Covers the store generator, DNS, kamal setup, and post-deploy verification end to end.

adammiribyan/wide_events · 58 tokens