reverse-documentation

A documentation generator that examines Rust and TypeScript code and explains its structure, relationships, and implementation patterns. It covers Rust APIs and React or Next.js applications.

In plain words
What is it for?
Creating API documentation, architecture notes, migration guides, READMEs, implementation guides, code examples, tutorials, and explanations of related components or patterns.
Why use it?
It turns an existing codebase into documentation when the original design or behavior is difficult to follow. This can reduce the manual work needed to maintain guides and references.

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/raphaelmansuy/edgequake/reverse-documentation
Any agent
npx skills add raphaelmansuy/edgequake --skill reverse-documentation
Clone the repo
git clone --depth 1 https://github.com/raphaelmansuy/edgequake

Made for: Claude Code, Codex.

Per session 41 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,977 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.00041 $0.01977
Opus 5 $0.00020 $0.00988
Sonnet 5 $0.00008 $0.00395
Haiku 4.5 $0.00004 $0.00198

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

Security

Grade A, and why

reverse-documentation 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.

.github/skills/reverse-documentation/SKILL.md · 312 lines

How it starts

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

Reverse Documentation Skill

Automatically generate comprehensive documentation for Rust and TypeScript codebases by analyzing existing code structure, patterns, and relationships.

When to use

Use this skill when you need to:

  • Generate comprehensive API documentation for Rust crates
  • Document React components and custom hooks
  • Create architecture documentation from code analysis
  • Generate migration guides for API changes
  • Create README and implementation guides
  • Document design patterns and relationships
  • Build code examples and tutorials
  • Cross-reference related functionality

Core concepts

Rust Documentation

This skill understands and documents:

  • Module Organization: Workspace structure, crate dependencies, feature flags
  • Types & Traits: Struct, enum, and trait definitions with full type signatures
  • Error Handling: Result types, custom error types, error propagation patterns
  • Async Patterns: Tokio-based async functions, futures, task spawning
  • Generic Types: Type parameters, bounds, and lifetime annotations
  • Implementation Details: Methods, associated functions, trait implementations
  • Testing: Unit tests, integration tests, documentation examples

TypeScript Documentation

This skill understands and documents:

  • Module Structure: Exports, re-exports, and module dependencies
  • Type Definitions: Interfaces, types, generics, and utility types
  • React Components: Functional components, props, state, lifecycle
  • Custom Hooks: Hook composition, state management, side effects
  • API Integration: Data fetching, request/response types, error handling
  • State Patterns: useState, useReducer, Context API, state management libraries
  • Next.js Patterns: Pages, layouts, API routes, middleware, server components

Quick start

For Rust codebases

Generate comprehensive documentation for the [crate-name] crate
Document the trait-based storage abstraction in edgequake-storage

Read the full file on GitHub · 312 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 · 312 lines · 41 tokens per session scan A 5316f52ed31e

Subscribe to this mod's changes

reverse-documentation is a skill published in the GitHub repository raphaelmansuy/edgequake (2,080 stars, last pushed 2d ago), licensed Apache-2.0. It adds 41 tokens to every session and 1,977 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-30.

Related

Other skills, from other repositories

potpie-graph

Use when the task can read or write the project-memory graph through the potpie CLI: discover the contract with graph catalog, read named views with graph read, resolve entity identity with graph search-entities, create validated plans with graph propose, commit plans with graph commit --verify, inspect quality with…

potpie-ai/potpie · 94 tokens

potpie-source-ingestion

Use when the user explicitly asks to ingest, refresh, or deeply understand a repository, PR, issue, ticket, runbook, incident report, document, or web link into Potpie. The harness performs todo-driven discovery, uses local/GitHub/integration tools and read-only subagents when available, builds evidence-backed…

potpie-ai/potpie · 82 tokens

potpie-repo-baseline

Use when establishing, refreshing, or deeply understanding a repository's baseline memory in Potpie: purpose, application type, features, services/modules, environments, deploy shape, dependencies, API contracts, datastores, integrations, ownership, and explicit preferences. The harness reads authored and…

potpie-ai/potpie · 75 tokens

graph-mutation-plan

Cookbook for composing an applygraphmutations plan — stable entitykey patterns, the canonical label/edge vocabulary, evidence/invalidation/confidence discipline, and a worked example. Load this when building a non-trivial mutation plan.

potpie-ai/potpie · 51 tokens

potpie-cli

Use when the task is centered on running, explaining, configuring, or troubleshooting the potpie command: doctor, login, pot management, source registration, search, graph workbench reads/writes, and pot scope behavior.

potpie-ai/potpie · 50 tokens

potpie-debug-memory

Use while debugging or troubleshooting failures, flaky tests, incidents, production alerts, CI failures, local dev setup issues, repeated bugs, prior fixes, failed attempts, and verification history.

potpie-ai/potpie · 41 tokens