reversa-docs

Convert Reversa core artifacts into a self-contained offline HTML mini-site.

1.5k|383|Updated Apr 26, 2026
One-click install
npx skills add https://github.com/sandeco/reversa --skill reversa-docs-sandeco
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reversa-docs
Source: https://github.com/sandeco/reversa/tree/main/agents/reversa-docs
Command: npx skills add https://github.com/sandeco/reversa --skill reversa-docs-sandeco

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Turns scattered legacy-system knowledge into an operational, navigable documentation mini-site for AI-agent-driven modernization, avoiding manual documentation gaps that slow safe evolution.

Core Features & Use Cases

  • Orchestrated docs pipeline: coordinates a fixed sequence of specialized agents (Mapper, Analyst, Storyteller, Publisher) to produce a complete documentation experience.
  • Deterministic, offline-ready visual outputs: generates self-contained HTML in .reversa/documentation/ using locally bundled vendor assets so pages work via file:// without external CDNs.
  • Traceable feature pages when specs exist: renders pages per SDD feature from _reversa_sdd/*/requirements.md when available, otherwise produces a minimal “selo + pointer” site.
  • Safe, non-destructive regeneration with checkpoints: reads existing artifacts, supports regeneration workflows with automatic backups, and preserves already generated pages on cancel.
  • Offline-first data model: injects data through assets/js/data.js produced by the Publisher step, ensuring pages don’t fetch local files directly.

Quick Start

Run the docs pipeline by invoking /reversa-docs in your Reversa-enabled project to generate the mini-site into .reversa/documentation/.

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 legacy system knowledge?

To generate offline HTML documentation from legacy system knowledge, you can use a multi-agent pipeline that converts extracted legacy artifacts into a self-contained mini-site. This process bundles vendor assets locally so the resulting pages work offline via the file:// protocol without requiring external CDNs.

Can I create navigable documentation without relying on external CDNs or internet access?

Yes, you can create navigable documentation without external CDNs by generating a self-contained HTML mini-site that injects data through local JavaScript files. This offline-first data model ensures pages do not fetch local files directly and remain fully operational without internet access.

How do I document software modernization efforts using SDD feature specs?

To document software modernization efforts using SDD feature specs, the pipeline renders traceable pages per feature from available requirements.md files. If feature specs are missing, it generates a minimal site with a pointer and marker instead of failing the documentation build.

What is the best way to safely regenerate legacy documentation without losing existing pages?

The best way to safely regenerate legacy documentation without losing existing pages is to use a non-destructive workflow that supports automatic backups. This process reads existing artifacts, preserves already generated pages if canceled, and strictly limits writes to a designated documentation directory.

Does the legacy documentation generation pipeline require YAML metadata discovery?

Yes, the legacy documentation generation pipeline requires YAML-defined metadata discovery to function correctly. This metadata drives the deterministic orchestration flow across specialized agents to ensure the generated mini-site accurately reflects the extracted legacy system topology and chronicle.

What are the limitations when building an offline HTML mini-site for AI agent modernization?

A key limitation when building an offline HTML mini-site for AI agent modernization is that all writes are strictly confined to a specific documentation directory, preventing accidental modification of source artifacts. Additionally, traceable feature pages are only produced when SDD requirements files already exist.