RFC companion documentation audit
Tier: Public Status: Living matrix — first pass 2026-05-27 Audience: maintainers, plan authors, agents implementing RFC-backed features Last reviewed: 2026-06-08
[!NOTE] Inventory of expected companion artifacts per accepted RFC. Remediation priorities drive the RFC documentation quality program (docs-only + toolset rules). Taxonomy:
docs/rfcs/README.md§3.
1. Verdict snapshot
| Verdict | RFCs |
|---|---|
| Documentation-complete | 0003, 0006, 0009, 0010 |
| Adequate with known gaps | 0001, 0004, 0005 |
| Drift-risk — P0 remediation shipped 2026-05-27 | 0007, 0008 |
| Medium follow-up | 0002 |
| Adequate (horizontal native) | — (see P1 row below) |
2. Full matrix (0001–0010)
| RFC | Impl. status | Expected companions | Present today | Gap | Priority |
|---|---|---|---|---|---|
| 0001 | Foundational | Automation surface; MODULES/PLATFORM | canonical-automation-module-surface.md; ecosystem docs | No single horizontal "modules governance" one-pager | Low |
| 0002 | Shipped | Route audit; brewery migration; native surface | web-route-group-audit.md; brewery scope migration; canonical-native-platform-surface.md | No consolidated β-layout cheat sheet | Medium |
| 0003 | Phase 1 | Audit doc | validation-library-adoption-audit.md | — | Met |
| 0004 | Partial | Module surface + build log | canonical-pim-module-surface.md, canonical-pim-build-log.md | Open work tracked in surface §8 | Low |
| 0005 | P1–P4 + post-P4 | Execution plan + build log | rfc-0005-execution-plan.md, rfc-0005-build-log.md | P5–P7 open per plan | Low |
| 0006 | Shipped | Bundled audit | web-route-group-audit.md | — | Met |
| 0007 | PR1–7 closed 2026-05-25 | Rationale + horizontal surface + consumer index | Rationale; PIM §8.3; horizontal surface added 2026-05-27 | Registry must stay updated per new templates | Was High |
| 0008 | Contract only | Boundary surface (pre-impl) | RFC text; surface added 2026-05-27 | Transport service not built | Was High |
| 0009 | Contract only | Boundary surface (pre-impl) | canonical-workspace-billing-addons-surface.md | WorkspaceBillingAddon + enforcement H1 2027 | Met |
| 0010 | Shipped 2026-05-28 | As-built runbook + migration | platform-brewery-postgres-schema-split.md | — | Met |
| 0011 | Shipped 2026-06-06 | Shell backbone companion | pre-flip-application-surface-backbone.md | §6.3 tier tree updated RFC-0012 | Low |
| 0012 | Shipped 2026-06-08 | Onboarding map | NAVIGATE-MONOREPO.md | Registry publish 0.2.0 pending sdk-batch-v0.2.0 | Low |
Implementation closure references: RFC-0007 §12 / §15.1; PIM PR7 pimChannelFeeds.test.ts; MRP/CRP Wave 6 mrp-crp-wave-6-rendering-templates-build-log.md. RFC-0010 migration: services/api/prisma/migrations/20260528170000_split_platform_brewery_schemas/migration.sql.
3. P0 / P1 / P2 remediation
P0 (closed 2026-05-27)
| Deliverable | Path | Owner action on change |
|---|---|---|
| Rendering horizontal surface | canonical-document-rendering-surface.md | Update template registry when adding documentTemplates |
| Notifications boundary surface | canonical-notifications-outbound-delivery-surface.md | Amend when RFC-0008 implementation starts |
| RFC-0007 cross-links | 0007-canonical-document-rendering.md §14 | Point to horizontal surface |
| Rendering package README | packages/platform/rendering/README.md | Consumer modules subsection |
| AI consultant index | AI-CONSULTANT.md | Template ref SoT = horizontal surface |
| AI prompt composition surface | canonical-ai-prompt-composition-surface.md | Update when aiPrompts SDK fields or composition order change |
P1 (next tranche)
| Deliverable | Path | Owner action on change |
|---|---|---|
| AI propose-write surface | canonical-ai-propose-write-surface.md | Update API paths, tool names, statuses when propose/apply changes |
| AI reporting DSL surface | canonical-ai-reporting-dsl-surface.md | Update view registry + AST when adding reporting views |
| AI RAG surface | canonical-ai-rag-surface.md | Update ingest corpus + schema when RAG phases ship |
| AI post-α H2 build log | ai-consultant-post-alpha-h2-build-log.md | Append per wave; link verification commands |
| AI prompt composition (maintenance) | canonical-ai-prompt-composition-surface.md | Sync module aiPrompts + route maps when adding modules or RouteIds |
| Native horizontal surface | canonical-native-platform-surface.md | Update route matrix when promoting native routes; update §5 when demo scope shifts |
| Ubuntu Touch workspace web UI | ubuntu-touch-shell-strategy.md | Update module eligibility / trade-offs when UT packaging changes; reference package at packaging/ubuntu-touch/umbraculum-reference/ |
| Demo host runbook | demo-host-runbook.md | Update demo accounts table when seed emails change |
| Cloud hosted track (stub) | cloud-hosted-product-track.md | Amend when cloud.umbraculum.dev work starts |
| RFC-0002 native companion | 0002-canonical-module-physical-layout.md §5 | Link to native surface when registerNativeModule behavior changes |
- Module surfaces: ensure Rendering subsections in MRP/CRP/PIM/automation point at horizontal surface + module refs (MRP/CRP updated in Wave 6).
- Optional:
canonical-module-physical-layout-as-built.md— β-layout cheat sheet (RFC-0002). - RFC index: brewery migration doc rollup under RFC-0002 row.
P2 (automation)
scripts/docs/check-rfc-companion-links.py— companion path existence check.- Promote to blocking CI after one green cycle on
main.
4. Maintenance
- Refresh Last reviewed on this file when any RFC row changes or a new RFC is accepted.
- When accepting 0011+, add a row before merging the RFC index update.
- Quarterly: spot-check template registry in rendering surface against
listRegisteredDocumentTemplates()/ moduledocumentTemplates.tsfiles.
5. Cross-references
docs/rfcs/README.md§3 — taxonomyplan-documentation-context-template.md— plan authoringdocs/CURSOR-PLUGINS.md— rules48-rfc-companion-documentation-gate,49-plan-documentation-context