reversa-docs

Generate a self-contained offline HTML mini-site from Reversa core knowledge.

Updated Mar 31, 2026

Search Tags:#architecture #documentation #orchestration #offline-first #html mini-site #reproducible visuals

Ready to run

npx skills add https://github.com/afsjr/secretaria_escola_csm --skill reversa-docs-afsjr

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: reversa-docs
Source: https://github.com/afsjr/secretaria_escola_csm/tree/main/.agents/skills/reversa-docs
Command: npx skills add https://github.com/afsjr/secretaria_escola_csm --skill reversa-docs-afsjr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Turns already-extracted Reversa knowledge into a navigable, self-contained HTML documentation mini-site without requiring you to manually assemble pages from raw artifacts.

Core Features & Use Cases

Orchestration into a mini-site: Builds a complete, offline-friendly documentation package in .reversa/documentation/ (index, architecture, metrics, glossary, and feature pages).
Deterministic, reproducible visual rendering: Uses a seed derived from .reversa/soul.md (or project name) to keep visuals stable across runs and supports --seed override.
Graceful greenfield fallback: If core sources are missing, produces a minimal site (selo + pointer) instead of failing hard.
Sequential specialist pipeline: Runs Mapper, Analyst, Storyteller, and Publisher in a fixed order, with optional isolated regeneration for focused updates.

Quick Start

Run /reversa-docs --auto to generate the documentation mini-site with default settings for a fast first render.

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 offline HTML documentation mini-site from existing project files?▼

To generate an offline HTML documentation mini-site, this Skill orchestrates mapping, analysis, storytelling, and publishing into a self-contained package within `.reversa/documentation/`. It bundles vendor assets for `file://` compatibility and omits pages whose required sources are absent.

What is the best way to build reproducible visuals for architectural documentation?▼

Reproducible visuals for architectural documentation are built using a deterministic seed derived from `.reversa/soul.md` or the project name. This approach ensures visual rendering remains stable across multiple runs, and you can override the default seed using the `--seed` parameter.

Do I need SDD specs to generate architecture and feature pages?▼

You need SDD specs to generate specific project documentation pages such as architectural visualizations, metric dashboards, and per-feature pages. If core sources are missing, the pipeline applies a graceful greenfield fallback to produce a minimal site instead of failing.

How do I run an isolated regeneration for a specific documentation page?▼

You run isolated regeneration for focused updates by triggering the sequential specialist pipeline with targeted parameters. The pipeline processes Mapper, Analyst, Storyteller, and Publisher in a fixed order, persisting state in `.reversa/documentation/.state.json` to support selective rebuilds.

Why does my documentation mini-site omit certain pages like metrics or glossaries?▼

Your documentation mini-site omits specific pages like metrics or glossaries when their required sources are absent from `.reversa/state.json`. The orchestration pipeline automatically detects missing core knowledge and skips the generation of those corresponding pages.

Can I use this documentation orchestration pipeline without reading state configuration files?▼

You cannot use this documentation orchestration pipeline without reading `.reversa/state.json`, which is a strict requirement for extracting core knowledge. An optional `.reversa/documentation/.config.json` file can also be read to override default generation settings.