Long-form documentation for BrandDocs. The top-level
README.md stays intentionally short; everything else lives here.
Not to be confused with
docs/, which is the published GitHub Pages site (HTML, sitemap, robots,llms.txt), not human documentation.
| Document | What's inside |
|---|---|
| INSTALLATION.md | Prerequisites (required + optional visual QA) and every install method: Claude Code plugin, Git submodule, Codex clone, updating. |
| USAGE.md | Common use cases and the structured IntermediateDocument / GridDocument input format. (The quick start lives in the README.) |
| ARCHITECTURE.md | How it works (extract → generate → verify), structure-awareness, the reliability/repair loop, the Brand Kit, and why this beats "just ask an AI". |
| SKILLS.md | The three skills (brand-docx / brand-pptx / brand-xlsx) and the project status table. |
| PLUGIN_WORKFLOW.md | The full end-to-end agent workflow: skill selection, preflight, extract/comprehend/generate/QA, visual manifests, repair rounds. |
| DEVELOPMENT.md | Local dev setup, test suites, and contribution conventions. |
| ROADMAP.md | Planned, designed-but-not-yet-built features and the next-wave cluster status. |
The FAQ lives in ARCHITECTURE.md. The strategic self-assessment and the hardening plan live in the top-level REFLECTIONS.md.