reversa-docs

Generate an offline HTML mini-site documenting Reversa core artifacts under .reversa/documentation/.

Updated May 16, 2026
One-click install
npx skills add https://github.com/ricardops34/rcg-crm --skill reversa-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reversa-docs
Source: https://github.com/ricardops34/rcg-crm/tree/main/.agents/skills/reversa-docs
Command: npx skills add https://github.com/ricardops34/rcg-crm --skill reversa-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

It converts extracted Reversa core knowledge into a ready-to-open, offline-friendly mini-site HTML so stakeholders and developers can navigate architecture, metrics, glossary, and feature specs without reading raw artifacts.

Core Features & Use Cases

  • Autonomous mini-site generation: Builds a complete documentation set in .reversa/documentation/ including index, navigation, and visualization-driven pages.
  • Orchestrates specialized agents end-to-end: Runs the Reversa Docs pipeline (Mapper, Analyst, Storyteller, Publisher) in a fixed sequence to produce consistent outputs from the same source knowledge.
  • Graceful source availability handling: Detects which core inputs exist and omits dependent pages when inputs are missing, producing a minimal but usable site.
  • Offline, file:// safe viewing: Ensures generated pages work without remote CDN calls by bundling required vendor libraries to local assets/vendor/.
  • Regeneration and targeted reruns: Supports full regeneration, per-agent regeneration, per-page regeneration, and interview retakes with backups for destructive writes.

Quick Start

Run the skill with the command /reversa-docs --auto to generate the documentation mini-site in .reversa/documentation/ using default reader profile, full depth, and a sober visual style.

Frequently Asked Questions about reversa-docs

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

FAQPage Schema
How do I generate offline HTML documentation from extracted architecture and feature specs?

Generate offline HTML documentation by running the pipeline to transform extracted architecture and feature specs into a self-contained mini-site. It bundles local vendor assets and writes navigable pages strictly under .reversa/documentation/.

Can I view generated project documentation offline without remote CDN dependencies?

Yes, generated project documentation works offline without remote CDN dependencies. The process bundles required vendor libraries into local assets/vendor/ directories, ensuring file:// safe viewing for all architecture and glossary pages.

What happens if some source files are missing when generating a static documentation mini-site?

When source files are missing during static documentation mini-site generation, the pipeline gracefully detects absent inputs and omits dependent pages. It produces a minimal but usable site instead of failing the entire build process.

How do I regenerate specific documentation pages without rebuilding the entire architecture mini-site?

Regenerate specific documentation pages without rebuilding the entire architecture mini-site using per-page or per-agent regeneration. The system supports targeted reruns and creates backups for destructive writes to preserve previous state.

Does generating offline documentation require reading state configuration files?

Generating offline documentation requires reading .reversa/state.json and .reversa/documentation/.config.json if present. It also detects expected sources from references/expected_sources.yaml to orchestrate the documentation pipeline correctly.

What is the best way to publish extracted Reversa core knowledge as a navigable project documentation bundle?

The best way to publish extracted knowledge as a navigable project documentation bundle is orchestrating specialized agents in sequence. The pipeline runs Mapper, Analyst, Storyteller, and Publisher agents to produce consistent architecture, metrics, and glossary outputs.