plannotator-visual-explainer

Featured

Generate self-contained HTML visualizations with Plannotator theming. Use for implementation plans, PR explainers, architecture diagrams, data tables, slide decks, and any visual explanation of technical concepts. Plans and PR explainers follow Plannotator's prescriptive approach; all other visual content delegates to nicobailon/visual-explainer.

AI & Automation 7,386 stars 535 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 96/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Plannotator Visual Explainer Three paths depending on content type. Each has its own references and structure. ## Route by content type **Implementation plan, design doc, or proposal** → Follow the [Plan path](#plan-path). Read `references/design-system.md` and `references/svg-patterns.md`. Prescriptive structure. **PR explainer, diff review, or code change walkthrough** → Follow the [PR path](#pr-path). Read `references/design-system.md` and `references/pr-components.md`. Prescriptive structure. **Everything else** (architecture diagrams, data tables, slide decks, project recaps, general visual explanations) → Follow the [Visual explainer path](#visual-explainer-path). Delegates to nicobailon/visual-explainer with Plannotator theme tokens. ## Delivery Always deliver via Plannotator's annotation UI. Do NOT use `open` or `xdg-open`. For any deliverable that uses Mermaid, render every diagram with Mermaid 11 in both the light and dark palettes before opening the annotation UI. Rendering is a hard gate: an exception, empty SVG, or error output such as `aria-roledescription="error"` or `Syntax error in text` means the explainer is not deliverable. Fix the diagram or theme configuration and rerun both palettes until every SVG passes. **Plans/proposals** (user should approve/deny): ```bash plannotator annotate <file> --gate ``` **Everything else** (informational): ```bash plannotator annotate <file> ``` --- ## Plan path For implementation plans, design docs, feature ...

Details

Author
backnotprop
Repository
backnotprop/plannotator
Created
7 months ago
Last Updated
today
Language
TypeScript
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category