reversa-docs

Generates a self-contained HTML mini-site documenting project architecture, metrics, and features.

Updated Jun 12, 2026
One-click install
npx skills add https://github.com/lacsousa/mediclaw-system --skill reversa-docs-lacsousa
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: reversa-docs
Source: https://github.com/lacsousa/mediclaw-system/tree/main/.agents/skills/reversa-docs
Command: npx skills add https://github.com/lacsousa/mediclaw-system --skill reversa-docs-lacsousa

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Teams that reverse-engineer a legacy project end up with scattered knowledge artifacts (soul.md, chronicle.md, SDD specs) that are hard to navigate. This Skill orchestrates a four-agent pipeline that renders that extracted knowledge into a self-contained, navigable HTML mini-site in _reversa_docs/ that works offline and via double-click. ## Core Features & Use Cases - Sequential 4-agent pipeline: Mapper (3D architecture and module pages), Analyst (metrics and timeline dashboards), Storyteller (glossary, deck, per-feature pages), and Publisher (index, navigation, vendor bundling, smoke test). - Offline and file:// compatible: downloads Three.js, D3, and Highcharts into assets/vendor/ and embeds data in assets/js/data.js so no server or internet is needed. - Guided configuration and regeneration: a 3-question interview (reader profile, depth, visual style) persisted in .config.json, plus backup-based partial or full regeneration and an --auto mode. - Use Case: After running /reversa on a legacy codebase, invoke /reversa-docs to produce an interactive documentation site with a 3D Code City, metrics dashboards, and feature pages for onboarding a new developer. ## Quick Start Run /reversa-docs in your project after the Reversa core extraction to generate the interactive documentation mini-site in _reversa_docs/.

Frequently Asked Questions about reversa-docs

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

FAQPage Schema
How do I generate an interactive HTML documentation site from a legacy project?▼

Run the Reversa core extraction first to produce soul.md, chronicle.md, and SDD specs, then invoke /reversa-docs. It orchestrates four agents that render architecture, metrics, glossary, and feature pages into _reversa_docs/ as a self-contained mini-site.

What does the reversa-docs pipeline produce?▼

It produces a mini-site in _reversa_docs/ containing arquitetura.html, modulos.html, metricas.html, timeline.html, glossario.html, a deck, per-feature pages, and an index.html with navigation. Pages are omitted gracefully when their source artifacts are missing.

Does the generated mini-site work offline without a server?▼

Yes. The Publisher downloads Three.js, D3, and Highcharts into assets/vendor/ and embeds all data in assets/js/data.js, so index.html works via double-click over file:// with no fetch calls or CDN references.

Can I regenerate only part of the documentation site?▼

Yes. On a second run you can regenerate everything, a single agent's pages, or one specific page. Each agent is also invocable standalone via /reversa-docs-<name>, and automatic backups are created in .backup-<timestamp>/ before any overwrite.

What happens if no Reversa artifacts exist in the project?▼

The skill detects missing sources and offers to either run /reversa first or generate a minimal index page with only the seal. Pages depending on absent sources are omitted with recorded reasons rather than failing.

What are the limitations of the reversa-docs skill?▼

It never writes outside _reversa_docs/ and only reads core artifacts, so it cannot extract knowledge itself. It depends on prior Reversa extraction output, and visual reproducibility relies on a sha256 seed derived from soul.md or the project name.