rb:document

A documentation workflow for completed Ruby, Rails, and Grape features, covering code comments, README sections, and ADRs—short records of important design decisions.

In plain words
What is it for?
Use it after review to document public classes and methods, explain user-facing features, and record architectural decisions.
Why use it?
It reduces onboarding friction and preserves both how public code is used and why significant implementation choices were made.

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/slbug/claude-ruby-grape-rails/document
Any agent
npx skills add slbug/claude-ruby-grape-rails --skill document
Clone the repo
git clone --depth 1 https://github.com/slbug/claude-ruby-grape-rails

Made for: Claude Code, Codex.

Per session 36 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 749 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.00036 $0.00749
Opus 5 $0.00018 $0.00375
Sonnet 5 $0.00007 $0.00150
Haiku 4.5 $0.00004 $0.00075

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

Security

Grade A, and why

rb:document 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.

plugins/ruby-grape-rails/skills/document/SKILL.md · 84 lines

How it starts

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

Document

Generate documentation for newly implemented features.

Usage

/rb:document .claude/plans/magic-link-auth/plan.md
/rb:document magic link authentication
/rb:document  # Auto-detect from recent plan

Iron Laws

  1. Never remove existing documentation — Existing docs may reflect design intent that isn't obvious from code alone; update rather than replace
  2. YARD/RDoc on every public class/module — Undocumented code accumulates quickly and creates onboarding friction for new team members
  3. ADRs capture the "why", not the "what" — Code shows what was built; ADRs explain why this approach was chosen over alternatives
  4. Match docs to method's public API — Document parameters, return values, and edge cases; callers shouldn't need to read the implementation

What Gets Documented

Output Description
Class/module docs For new classes/modules missing documentation
Method docs For public methods without docs
README section For user-facing features
ADR For significant architectural decisions

Workflow

Step 0: Pre-check (avoid no-op runs)

Run ${CLAUDE_PLUGIN_ROOT}/bin/resolve-base-ref → 3 KEY=value lines on stdout (BASE_REF, REMOTE, DEFAULT_BRANCH). Substitute the values into subsequent Bash commands: run git merge-base HEAD BASE_REF_VALUE and capture the result. Run git diff --name-only --diff-filter=A MERGE_BASE_VALUE HEAD -- '*.rb' to list new Ruby files added on the current branch.

If NO new .rb files were added (only modifications), skip the full audit and report: "No new modules — documentation coverage unchanged." This prevents 35-message analysis sessions that conclude "PASS" with zero output (confirmed: session bb0a0454 wasted ~2K tokens on no-op).

  1. Identify new modules from recent commits or plan file
  2. Check documentation coverage (YARD, RDoc)
  3. Generate missing docs using templates
  4. Add README section if user-facing feature
  5. Create ADR if architectural decision was made
  6. Write report to .claude/plans/{slug}/docs/{feature}.md

Read the full file on GitHub · 84 lines

Files

What ships with it

4 files 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 · 84 lines · 36 tokens per session scan A 25a656add7df

Subscribe to this mod's changes

rb:document is a skill published in the GitHub repository slbug/claude-ruby-grape-rails (7 stars, last pushed 2d ago), licensed MIT. It adds 36 tokens to every session and 749 once invoked, about $0.0002 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.