Skip to content

[Docs]: Documentation completion epic — public product surface after all features ship #66

Description

@rosspeili

Page or file

Entire public doc set: README.md, docs/**, examples/**/README.md, CONTRIBUTING.md (user-facing sections), CITATION.cff blurb if needed.

Type

missing information

What's wrong or missing?

When development completes, public docs must read as one coherent product — not an internal plan, not a roadmap dump, not ARPA stack mythology on the default path.

Remove or demote from default reader path:

  • Internal voice: MVP, test bed, integration strategy, "we will", issue numbers, AURA_PLAN language
  • Personas as product taxonomy (use illustrative patterns only — see using-aura refresh)
  • SoulSig / SCI / three-rings / field-services as required reading for adopters
  • Stale "v0.2 modules", "egress roadmap", "planned" without a single ROADMAP pointer
  • Duplicate membrane diagrams across stack-position, architecture, concepts, using-aura, comparison

Present plainly (shipped truth only):

  • README tagline + subline
  • Three planes: Audit · Enforce · Escalate
  • Membrane model: wrap any loop; integrations index for stack-specific attach paths
  • Spectrum / levels, identity, capability broker, session receipt, CLI + onboarding flow
  • Examples ladder with cross-links; Gatekeeper as optional security appendix
  • Comparison vs LangGraph / CrewAI / DSH / tracing

Suggested fix (optional)

Schedule: after Phase D–E features land (spectrum #27, SLO, escalations, broker, coat ops, host wraps, Gatekeeper, signed packs). Reference ToolHost epic (#12) closed Aug 2026. Already shipped: onboarding (#13) PR #54, flat examples (#21) PR #30, session-export docs (#37), aura report show (#25). Docs sweep (#14) is the ongoing mid-pass — this epic finishes at product-complete.

Deliverables:

  1. Rewrite docs/INDEX.md — three tiers (Start / Build / Decide); ROADMAP.md sole deferrals file
  2. Polish docs/onboarding.md (shipped); add docs/security.md if Gatekeeper lands; optional docs/session-export.md
  3. Cross-reference pass on every doc; tone rules (present tense, example patterns, integrations index)
  4. Consolidate stack-position, trim narrative/three-rings from tier-1, refresh comparison/architecture/field-services
  5. Verification checklist: onboarding without narrative.md; no unshipped claims; CI smoke on examples

Block until shipped or documented as planned: spectrum (#27), SLO/escalations, coat ops, broker, identity/Gatekeeper, signed packs. Already shipped: ToolHost reference coat (#12), capstone guide, verify CLI (#24), onboarding (#13), flat core examples (#21), examples 05–08 (host wraps draft still open).

Metadata

Metadata

Assignees

Labels

documentationDocs, README, or glossary updates.enhancementNew feature or improvement request.help wantedExtra attention is needed.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions