skills.rest
RLuf
RLufCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

reversa-docs

Generates a self-contained HTML documentation mini-site from extracted project knowledge artifacts.

Updated Jun 26, 2026
Search Tags:#html generation#documentation#onboarding#orchestration#static site#reverse engineering#code visualization
One-click install
npx skills add https://github.com/RLuf/fzagent --skill reversa-docs-rluf
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: reversa-docs
Source: https://github.com/RLuf/fzagent/tree/main/.agents/skills/reversa-docs
Command: npx skills add https://github.com/RLuf/fzagent --skill reversa-docs-rluf

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, architecture notes) that are hard to navigate. This Skill orchestrates a four-agent pipeline that renders those artifacts into a self-contained, navigable HTML mini-site with 3D architecture views, dashboards, glossary, and feature pages. ## Core Features & Use Cases - Sequential 4-agent pipeline: Mapper (spatial structure), Analyst (quantitative data), Storyteller (narrative and onboarding), and Publisher (integration, seal, auto-discovery), each also invocable in isolation. - Offline and file:// compatible output: vendors Three.js, D3, and Highcharts locally and embeds data via assets/js/data.js, so the site opens with a double click and no server. - Guided interview and regeneration: collects reader profile, depth, and visual style once, persists them in .config.json, and supports full or partial regeneration with automatic timestamped backups. - Use Case: After running the Reversa core extraction on a legacy codebase, invoke the orchestrator to produce .reversa/documentation/index.html with architecture, metrics, timeline, glossary, and per-feature pages for onboarding a new developer. ## Quick Start Ask the agent to run /reversa-docs to generate the interactive documentation mini-site from the knowledge already extracted into .reversa and _reversa_sdd.

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 codebase?▼

Run the Reversa core extraction first to produce soul.md, chronicle.md, and SDD specs, then invoke /reversa-docs. It orchestrates Mapper, Analyst, Storyteller, and Publisher agents to render a navigable mini-site in .reversa/documentation/.

How to create project documentation that works offline without a web server?▼

The generated mini-site vendors Three.js, D3, and Highcharts into assets/vendor/ and embeds data in assets/js/data.js instead of using fetch calls. This makes every page work via file:// with a double click, no server or internet required.

Can I regenerate only part of the generated documentation site?▼

Yes. On a second run the orchestrator detects the existing .state.json and offers options to regenerate everything, a single agent's pages, or one specific page. Each agent is also invocable in isolation via /reversa-docs-<name> for focused regeneration.

What happens if the extracted knowledge sources are missing?▼

Missing sources never block the pipeline; dependent pages are omitted gracefully with recorded reasons. If no sources exist at all, the skill offers to run /reversa first or produce a minimal index page with just the seal.

Does the documentation generator modify my source code or extraction artifacts?▼

No. The skill is strictly non-destructive: it only writes inside .reversa/documentation/ and reads core artifacts like _reversa_sdd/ and .reversa/soul.md. Any overwrite requires an automatic timestamped backup first.

Related Skills

Explore More Software Engineering Skills→
GleisonOliveiraGleisonOliveira

reversa-docs

Generates a self-contained HTML mini-site with 3D architecture, dashboards, and feature pages from extracted project knowledge.

Community
Advanced
ZJU-REALZJU-REAL
195

site-builder

Build and publish accessible websites from user ideas to hosted URLs.

Official
Advanced
0xHoneyJar0xHoneyJar

speaking

Generate RLM-isolated follow-up messages enriched with chronicle events per user.

Official
Advanced
hnabyz-bothnabyz-bot

moai-docs-generation

Generate API references and user manuals from source code using Sphinx, MkDocs, TypeDoc, or Docusaurus.

Community
Intermediate