Authoritative pointer-set for V1 documentation. Each section below names the canonical document(s); deeper specs and per-domain documents are reachable through these entry points.
Architecture and ownership#
- Oshun ownership matrix quick-reference:
docs/oshun/ownership-matrix.md. - Subsystem ownership matrix (authoritative for V1):
docs/releases/v1/reports/subsystem-ownership-matrix.md. - Program charter and ownership sections:
docs/releases/v1/specs/program-charter.md. - Architecture specs:
docs/releases/v1/specs/— per-area design and decision documents (contract index, cross-domain versioning, domain consolidation, documentation standards, when- to-call-which-subsystem guide, etc.). - Reference docs (legacy and current):
docs/reference/— including the legacy data-ownership matrix for migration planning.
Information architecture#
- Customer IA and experience quality:
docs/oshun/ia-and-experience-quality.md. - Admin IA:
docs/oshun/admin-ia.md. The admin route tree underapps/oshun/admin/src/app/is the structural source of truth; the IA document is the customer-facing reference.
Data model#
- Overview narrative:
docs/oshun/data-model.md. - Contracts (machine-readable):
libs/contracts/src/. - Persistence layer (Prisma renderer, migration plan, tombstone semantics,
index requirements):
libs/oshun/persistence/src/. - Canonical contract index and required queries:
docs/releases/v1/specs/canonical-contract-index-and-query-requirements.md. - Cross-domain contract versioning:
docs/releases/v1/specs/cross-domain-contract-versioning.md. - Domain-specific data models:
docs/domains/<domain>/data-models.md(deep dives per domain).
Testing strategy#
- Automation matrix (per change-type required checks):
docs/testing/automation-matrix.md. - CI coverage manifests (machine-readable):
libs/oshun/analytics/src/web-playwright-ci-coverage.tslibs/oshun/analytics/src/mobile-e2e-ci-coverage.tslibs/oshun/analytics/src/accessibility-and-lighthouse-ci-coverage.tslibs/oshun/analytics/src/qa-coverage-matrices.ts
- QA governance and enforcement:
libs/oshun/analytics/src/qa-governance-and-enforcement.ts.
Evaluation pipeline#
- Evaluation manifest (canonical benchmark + threshold registry):
libs/oshun/analytics/src/evaluation-manifest.ts. - Experimentation manifest:
libs/oshun/analytics/src/experimentation-manifest.ts. - Per-domain evaluation context: each domain library's evaluation tests;
persona evaluation under
libs/oshun/persona-policy-lilith/; model evaluation under Isis-owned modules.
Release gates#
- Security gates:
docs/security/v1-release-security-gates.mdpaired withdocs/security/pentest/,docs/security/red-team/. - Launch readiness checklist:
docs/launch/go-no-go.md. - Release taxonomy (machine-readable events for promotions, canary,
rollback):
libs/oshun/analytics/src/release-taxonomy.ts. - V1 release and exit criteria manifest:
libs/oshun/analytics/src/v1-release-and-exit-criteria-manifest.ts.
Launch readiness#
- Locale coverage:
docs/launch/locale-coverage.md. - Translation workflow:
docs/launch/translation-workflow.md. - Content bundles:
docs/content/v1-bundles.md. - Launch readiness manifest (machine-readable):
libs/oshun/analytics/src/v1-launch-readiness-manifest.ts. - 32.X content/localization/docs signoff manifest (machine-readable):
libs/oshun/analytics/src/v1-32-content-localization-documentation.ts.
Operations#
- Runbooks:
docs/runbooks/oshun-v1.mdindexes the per-incident runbooks (shell, grounding, assistant, provider, moderation, privacy, model/workflow, persona, provenance, watermark). - Operator training:
docs/training/oshun-v1-operator-training.mdindexes the per-track programs (support, moderators, reviewers, persona, model, privacy, compliance, product, launch support). - Incident ownership and templates:
libs/oshun/analytics/src/incident-ownership-manifest.ts. - Alerts manifest:
libs/oshun/analytics/src/alerts-manifest.ts.
Cross-cutting policies#
- Messaging boundary (third-party channel policy):
docs/oshun/messaging-boundary.md. - Privacy program:
docs/oshun/privacy/. - Compliance mappings (EU AI Act, NIST AI RMF, UNCITRAL ODR):
docs/compliance/eu-ai-act-mapping.md,docs/compliance/nist-ai-rmf-mapping.md,docs/compliance/uncitral-odr-mapping.md.
Update authority#
Maintaining this index is the responsibility of the program documentation lead. Pointer rot (a referenced file moves or is deleted) is a documentation-quality bug to be filed and fixed in the same release that moves the underlying artifact.