Prompt file imported from Zynapses/Radiant (
.windsurf/workflows/docs-assemble-complete.md). Copyright stays with the author.
Complete Documentation Assembly Policy
When This Policy Applies
This policy is triggered whenever any of the 21 documentation files (15 consolidated + 6 standalone) is modified:
docs/01-THINK-TANK.mdthroughdocs/18-UI-UX-LIBRARIES.mdCHANGELOG.md,README.md,SECURITY.md,CONTRIBUTING.md,TECHNICAL_DEBT.md
What It Does
Assembles ALL 21 documents (15 consolidated + 6 standalone) into a single comprehensive "RADIANT & Think Tank — Complete Documentation" file, available in both .md and .pdf formats.
The assembly:
- Logically orders all 21 documents (apps first, then systems, then standalone)
- Adds Part/Chapter structure with page breaks
- Generates a Table of Contents from the structure
- Includes assembly statistics (parts, chapters, lines)
- Outputs to
docs/publications/
Output Files
| File | Format | Description |
|---|---|---|
docs/publications/RADIANT-THINKTANK-COMPLETE-DOCUMENTATION.md |
Markdown | Complete assembled documentation |
docs/publications/RADIANT-THINKTANK-COMPLETE-DOCUMENTATION.pdf |
Print-ready version (via pandoc) |
How to Run
// turbo
- Run the assembly script:
python3 tools/scripts/assemble-complete-documentation.py
Prerequisites
- Python 3.10+ (available on all dev machines)
- pandoc (for PDF generation):
brew install pandoc - LaTeX (for PDF via pandoc):
brew install --cask mactex-no-guiorbrew install basictex- If LaTeX is not available, the script still generates the
.mdfile successfully
- If LaTeX is not available, the script still generates the
Document Structure (21 Documents: 15 Consolidated + 6 Standalone)
App Documents (1–5)
- Think Tank (
docs/01-THINK-TANK.md) — User guide, admin guide, tenant admin, Mac, licensing, Delight, collaboration, Dojo - Curator (
docs/02-CURATOR.md) — User guide + engineering guide - Radiant Admin (
docs/04-RADIANT-ADMIN.md) — Platform admin, deployment, system health, spend governor, SaaS metrics - Swift Deployer (
docs/05-SWIFT-DEPLOYER.md) — User guide + architecture
System Documents (6–19)
- Architecture & Engineering (
docs/06-ARCHITECTURE-ENGINEERING.md) — Platform architecture, CDK, engineering vision, gateway, Data & Storage - AI Systems (
docs/07-AI-SYSTEMS.md) — AGI brain, consciousness, cognitive, Cortex, CATO safety, ethics, GPU infra - OMEGA & Genesis (
docs/09-OMEGA-GENESIS.md) — OMEGA Protocol, Five Pillars, quantum brain, Helix, firmware, model routing, Global Brain - Orchestration & Workflows (
docs/10-ORCHESTRATION-WORKFLOWS.md) — Methods, reference, patterns, UEP - API Reference (
docs/12-API-REFERENCE.md) — APIs, versioning, error codes, service layer (MCP/A2A) - Security, Auth & Compliance (
docs/13-SECURITY-AUTH-COMPLIANCE.md) — Auth architecture, user/admin/tenant guides, MFA, OAuth - Operations & Runbooks (
docs/14-OPERATIONS-RUNBOOKS.md) — Deployment, incidents, scaling, performance, DR, testing - Strategy & Competitive (
docs/15-STRATEGY-COMPETITIVE.md) — Vision, moats, capabilities, pitch, revenue, tech debt - Implementation Specs (
docs/16-IMPLEMENTATION-SPECS.md) — Sections 00–46 (full technical build specs + DB schema) - Glossary (
docs/17-GLOSSARY.md) — Terms, definitions, acronyms - UI/UX & Libraries (
docs/18-UI-UX-LIBRARIES.md) — Design patterns, open source dependencies - Strategic Security (
docs/19-STRATEGIC-SECURITY.md) — Credential lifecycle security, NIST/CIS/SOC2/PCI/ISO compliance
Standalone Documents (20–25)
- OMEGA Engineering (
docs/20-OMEGA-ENGINEERING.md) — Engineering, architecture, marketing, API reference - Text-to-Speech (
docs/21-TEXT-TO-SPEECH.md) — TTS complete reference, ElevenLabs, voice presets - Compliance Standards Guide (
docs/22-COMPLIANCE-STANDARDS-GUIDE.md) — SOC 2, GDPR, HIPAA, ISO 27701, ISO 42001, HDS, DPF, PCI DSS - Engineering Roadmap (
docs/23-ENGINEERING-ROADMAP.md) — Milestones, priorities, timeline, dependencies - Cartridge Specializations (
docs/24-CARTRIDGE-SPECIALIZATIONS.md) — Brain-mapped taxonomy, .RADz format, PKI, vault, RNIR - Patents & IP Strategy (
docs/25-PATENTS.md) — Patent portfolio, OMEGA & Cartridge IP, provisional filings
Plus Root-Level Files
CHANGELOG.md,README.md,SECURITY.md,CONTRIBUTING.md,TECHNICAL_DEBT.md
Archive
Original 244 documentation files are preserved in docs/archive/:
docs/archive/pre-consolidation/— full snapshot before mergedocs/archive/build-artifacts/— old generated docsdocs/archive/code-exports/— code snapshotsdocs/archive/historical/— reports, gap analyses, proposals
Policy Enforcement
- AI agents: After completing documentation updates, remind the user that the complete documentation should be reassembled
- CI/CD: The assembly script can be added to CI to auto-generate on merge to main
- The generated files should NOT be committed to git — they are build artifacts
- Document count: Currently 21 documents (15 consolidated + 6 standalone). Update this count when new documents are added.
