skills.rest
oliyh
oliyhCOMMUNITY
Explore all skills by this author →
Website𝕏@oliyhGitHub

alluminate

Generate narrated static HTML documentation from an Allium specification file.

Updated Jul 24, 2026
Search Tags:#documentation#html#mermaid#specification#static site#wireframes#allium
One-click install
npx skills add https://github.com/oliyh/alluminate --skill alluminate-oliyh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: alluminate
Source: https://github.com/oliyh/alluminate/tree/main/skills/alluminate
Command: npx skills add https://github.com/oliyh/alluminate --skill alluminate-oliyh

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve? An Allium (.allium) specification is written for spec authors, not for the people who own, build, or use the system. This Skill turns a spec into a self-contained static HTML document that a non-spec-reader can pick up cold: a narrated walkthrough of how the system actually behaves, backed by a full reference appendix, diagrams, and wireframe mockups. ## Core Features & Use Cases - Narrative documentation: Produces an orientation, a cast of actors, and chronologically ordered journeys walked from the spec's entrypoints, written in plain domain language rather than raw Allium clause syntax. - Reference appendix and diagrams: Renders config/entity/rule/surface tables from allium model/plan JSON, plus hand-authored Mermaid relationship, sequence, and state diagrams. - Inline validation findings: Attaches allium check/analyse diagnostics (deadlocks, unreachable triggers, missing producers) to the exact journey step or construct they concern, phrased as plain-language caveats. - Wireframe mockups: Optionally generates a low-fidelity mockup per declared surface via the Wireframer skill, embedded inline in the journeys that reach it. - Use Case: Point it at spec/leadout.allium and get docs/alluminate/leadout/index.html — a static page you can commit, open directly, or publish via GitHub Pages. ## Quick Start Ask your AI assistant to run the alluminate skill against your .allium spec file to generate the HTML document under docs/alluminate/.

Frequently Asked Questions about alluminate

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

FAQPage Schema
How do I generate HTML documentation from an Allium spec?▼

Run the alluminate skill against your .allium file. It validates the spec, walks entrypoints into narrated journeys, and writes a self-contained page to docs/alluminate/<spec-name>/index.html that you can open directly or publish via GitHub Pages.

What tools does alluminate need to run?▼

Only an Allium spec file is strictly required. The allium CLI (brew install allium or cargo install allium-cli) enriches output with check/model/plan/analyse data, and the Wireframer skill adds surface mockups; both are optional and degrade gracefully.

Does alluminate modify my .allium spec file?▼

No. Alluminate is read-only with respect to the spec — it documents the spec as written and never edits it, nor does it verify whether the implementation matches the spec.

Why do the generated diagrams and mockups need internet access?▼

Diagrams render client-side via Mermaid.js from a CDN, and Wireframer mockups load wired-elements and Google Fonts. The page shows a warning banner only if the Mermaid CDN actually fails to load.

What are the limitations of alluminate with modular specs?▼

For modular specs using `use "..." as x`, alluminate documents only the given file's own declarations. Qualified references like oauth/Session render as plain text and are not expanded from the imported spec.

Related Skills

Explore More Software Engineering Skills→
juxtjuxt
10

tend

Edit and validate Allium behavioral specification files against CLI tooling.

Official
Advanced
huidgehuidge
2

static-markdown-site

Convert a Markdown directory into a static website with a grouped sidebar.

Community
Intermediate
jeffwweeejeffwweee

ui-designer

Generate HTML wireframes, React/MUI mockups, and design specifications.

Community
Intermediate
juxtjuxt
10

propagate

Generate unit, integration, property-based, and state machine tests from Allium behavioral specifications.

Official
Advanced