skills.rest
raphaelmansuy
raphaelmansuyCOMMUNITY
Explore all skills by this author →
Website𝕏@raphaelmansuyGitHub

reverse-documentation

Generate documentation for Rust and TypeScript codebases by analyzing code structure and patterns.

2.1k|244|Updated Dec 21, 2025
Search Tags:#typescript#code analysis#documentation#react#next.js#rust#api reference
One-click install
npx skills add https://github.com/raphaelmansuy/edgequake --skill reverse-documentation-raphaelmansuy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: reverse-documentation
Source: https://github.com/raphaelmansuy/edgequake/tree/main/.github/skills/reverse-documentation
Command: npx skills add https://github.com/raphaelmansuy/edgequake --skill reverse-documentation-raphaelmansuy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing and maintaining documentation for Rust crates and TypeScript/React codebases is time-consuming, and docs quickly drift out of sync with the actual code. This Skill analyzes existing source code to produce accurate, comprehensive documentation automatically. ## Core Features & Use Cases - Rust Documentation: Extracts and documents public types, traits, functions, error handling, async patterns, and workspace structure, including doc comments and architecture diagrams. - TypeScript/React Documentation: Documents React components, custom hooks, type definitions, API integration layers, and Next.js App Router patterns, with optional Storybook stories. - Multiple Output Formats: Produces Markdown READMEs, API references, inline doc comments, Mermaid diagrams, and migration guides. - Use Case: Point it at a crate like edgequake-storage to generate a full API reference with trait relationship diagrams, working code examples, and error handling documentation. ## Quick Start Ask the assistant to generate comprehensive documentation for a specific crate or component directory, for example: generate documentation for the edgequake-storage crate including all traits and error handling patterns.

Frequently Asked Questions about reverse-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API documentation for a Rust crate?▼

Invoke the skill with a request naming the target crate, such as generating documentation for edgequake-storage. It analyzes Cargo.toml, extracts public types, traits, and functions, and produces Markdown references with examples and diagrams.

How to document React components and custom hooks automatically?▼

Point the skill at your components or hooks directory, such as src/components or src/hooks. It extracts props with types, hook parameters and return values, and generates usage examples plus optional Storybook stories.

Does it support Next.js App Router projects?▼

Yes, it documents Next.js patterns including pages, layouts, API routes, middleware, and server components. It also covers shadcn/ui composition, SWR data fetching, and react-hook-form patterns.

What output formats can the documentation be generated in?▼

It produces Markdown READMEs and API references, inline Rust doc comments and TypeScript JSDoc, Mermaid diagrams for trait and component relationships, and Storybook stories for React components.

Why do generated Rust code examples fail to compile?▼

Examples fail when imports are missing or types are out of scope. The skill's validation phase tests examples before inclusion, so verify all referenced items are public and exported from the correct module.

What are the limitations of automated code documentation?▼

It only documents items accessible from the public API unless scope is set to all. Design rationale not expressed in code may be missed, so review generated docs for architectural context before publishing.

Related Skills

Explore More Software Engineering Skills→
keshavraj936keshavraj936

lint-and-validate

Lint and statically analyze Node.js and Python code modifications.

Community
Intermediate
alecanche04-cyberalecanche04-cyber

documentation-engineer

Creates and maintains technical documentation systems, API references, and developer knowledge bases.

Community
Intermediate
dorriodorrio

ln-401-task-executor

Execute a single implementation task with test-driven development and status updates.

Community
Intermediate
modu-aimodu-ai
1.2k

moai-docs-generation

Generates API references, user guides, and documentation sites using Sphinx, MkDocs, TypeDoc, and OpenAPI.

Official
Intermediate