docs

A documentation tool that reads a real codebase and writes or updates developer documents such as a README, API reference, operations runbook, onboarding guide, or changelog.

In plain words
What is it for?
Use it to document how a project works, describe its API, explain operational procedures, guide new developers, or create a changelog from Git history.
Why use it?
It reduces outdated or invented documentation by checking claims against the code before writing them. Update mode changes stale sections instead of replacing the whole document.

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/greglas75/zuvo/docs
Any agent
npx skills add greglas75/zuvo --skill docs
Clone the repo
git clone --depth 1 https://github.com/greglas75/zuvo

Made for: Claude Code, Codex.

Per session 68 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,996 The whole file, excluding the scripts and references it only reads on demand.
Security scan C 1 finding. 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.00068 $0.03996
Opus 5 $0.00034 $0.01998
Sonnet 5 $0.00014 $0.00799
Haiku 4.5 $0.00007 $0.00400

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

Security

Grade C, and why

docs scanned grade C with 1 finding 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.

Hidden instructionshighPrompt injection

Directives inside HTML comments, invisible characters or bidirectional overrides are read by the model and not by the person reviewing the file.

<!-- Evidence Map | Section | Source file(s) | |---------|---------------| | Quick Start | package.json:scripts (line 5-12) | | Configuration | .env.example (line 1-15) | | API: GET /users | src/routes/users.controller.t
skills/docs/SKILL.md · 459 lines

How it starts

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

zuvo:docs — Technical Documentation

Generate or update documentation by reading the actual codebase -- not from templates, not from memory, from real code.

Iron rule: Never write a claim in documentation without reading the source file it references first. Every section maps back to a source file via the Evidence Map.

Scope: README, API reference, runbooks, onboarding guides, changelogs. Out of scope: Architecture diagrams (use zuvo:architecture), code comments (out of scope), user-facing product docs (out of scope).

Argument Parsing

Input Action
(empty) Check if README.md exists. If yes: update it. If no: generate one. If user interaction is available, ask for preference.
readme [path] Write or update README for the module at [path]
api [path] Generate API reference from route/controller files at [path]
runbook [topic] Write operational runbook for a specific process
onboarding Write onboarding guide for new developers
update [file] Read existing doc, verify claims against source, patch stale sections
changelog Generate CHANGELOG.md from git history
changelog [range] Generate changelog for a specific range (e.g., v1.2.0..v1.3.0)

Non-interactive environments (Codex, Cursor):

  • No arguments: default to readme for project root
  • Target file exists: default to update mode (patch, not overwrite)

Mandatory File Loading

PHASE 0 — Bootstrap (before reading any source)

  1. ../../shared/includes/codesift-setup.md      -- [READ | MISSING -> WARN]
  2. ../../shared/includes/env-compat.md          -- [READ | MISSING -> WARN]

retrospective.md and run-logger.md are END-of-run includes — they are loaded at completion, not here.

Environment Compatibility

Read ../../shared/includes/env-compat.md for user interaction patterns.

CodeSift Integration

Read ../../shared/includes/codesift-setup.md for initialization.

Key tools for this skill:

Read the full file on GitHub · 459 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 · 459 lines · 68 tokens per session scan C 11b65869b8db

Subscribe to this mod's changes

docs is a skill published in the GitHub repository greglas75/zuvo (6 stars, last pushed 2d ago), licensed MIT. It adds 68 tokens to every session and 3,996 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it C with 1 finding (hidden instructions). 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

ring:applying-composition-patterns

React composition patterns that scale. Avoid boolean prop proliferation by using compound components, lifting state, and composing internals. Use when refactoring components with boolean prop proliferation, building flexible component libraries, or during architecture review. Skip for simple components with 1-2 props…

LerianStudio/ring · 68 tokens

ring:adopting-lib-commons-huma-wrapper

Adopting the lib-commons/v5 shared Huma (OAS 3.1) OpenAPI wrapper + RFC 9457 problem model (commons/net/http/{openapi,problem}) in a Lerian Go service: wire openapi.New/ServeSpec + problem.Install (central >=500 scrub) on BOTH runtime and spec-gen paths, the per-rail problem.MapError flex seam, and rename-only spec…

LerianStudio/ring · 142 tokens

ring:searching-code

Forensic code search and analysis with optional Chain of Draft (CoD) ultra-concise mode. Five-phase methodology (clarification, planning, execution, analysis, synthesis) with severity assessment. Use for targeted investigation of specific patterns, bugs, or vulnerabilities. Skip for broad architecture mapping (use…

LerianStudio/ring · 74 tokens

ring:exploring-codebases

Exploring a codebase across phases: scopes the target, detects architecture, components, and layers, deep-dives each discovered perspective, then synthesizes findings into actionable guidance with file:line evidence. Use to understand how a feature or system works before planning changes, or to orient on an unfamiliar…

LerianStudio/ring · 91 tokens

ring:opening-pull-requests

Open a GitHub Pull Request with automatic base branch detection, scope allowlist enforcement, PR template filling, and post-create base verification. Replaces ring:generating-pr-descriptions. Use after pushing a branch when ready to open a PR. Skip if the branch is not yet pushed or there are uncommitted changes …

LerianStudio/ring · 83 tokens

ring:fixing-lint

Fixing lint to a clean state: runs the linter, groups reported issues into independent streams, and dispatches one parallel fixer agent per stream (ring:backend-go for Go, ring:general-purpose otherwise), iterating until clean. Use when a codebase has lint errors across multiple files. Skip for a single error (fix…

LerianStudio/ring · 96 tokens