Skip to main content

Canonical Documentation Map

This is the canonical index for all V1 live documentation. It is the single source of truth for which docs are active, which are evidence, and which are internal-only.

1. V1 Live Status

DocPathCanonical
V1 Live Truth Matrixdocs/launch/v1-live-truth-matrix.md
V1 Live Evidence Indexdocs/launch/v1-live-evidence-index.md
Post-Cloud Publication Plandocs/launch/post-cloud-publication-plan.md
Truth Matrix JSONstatic/ai/v1/v1-live-truth-matrix.json
Provider Validation Plan JSONstatic/ai/v1/provider-live-validation-plan.json
Launch Status (start-here)docs/start-here/launch-status.md
Current Statusdocs/start-here/current-status.md

2. Provider Lifecycle

DocPathCanonical
ProviderFlow README (index)docs/providerflow/README.md
ProviderFlow Overviewdocs/providerflow/overview.md
Package Contractdocs/providerflow/package-contract.md
YAML/DAG Contractdocs/providerflow/yaml-dag-contract.md
Package Validationdocs/providerflow/package-validation.md
Security Modeldocs/providerflow/security-model.md
Fixtures, Goldens, Tracesdocs/providerflow/fixtures-goldens-traces.md
Provider Package Lifecycledocs/providerflow/provider-package-lifecycle.md
V1 Provider Package Readiness Matrixdocs/providerflow/provider-package-v1-readiness-matrix.md
Known Nonclaimsdocs/providerflow/nonclaims.md
Template Packsdocs/providerflow/template-packs.md
Post-Cloud Validation Overviewdocs/providerflow/post-cloud-provider-validation-overview.md
Provider Test Account Checklistdocs/providerflow/provider-test-account-checklist.md

Provider Packages

PackagePathMaturity
Stripe v2docs/providerflow/packages/stripe-v2.mdGA
GitHub v2docs/providerflow/packages/github-v2.mdGA
Shopify v2docs/providerflow/packages/shopify-v2.mdPreview
Twilio v2docs/providerflow/packages/twilio-v2.mdPreview
Doppler (internal)docs/providerflow/packages/doppler-internal.mdInternal
GitLab (internal)docs/providerflow/packages/gitlab-internal.mdInternal
Terraform Cloud (internal)docs/providerflow/packages/terraform-cloud-internal.mdInternal

Post-Cloud Validation Runbooks

RunbookPath
Stripe Post-Clouddocs/providerflow/stripe-post-cloud-validation-runbook.md
GitHub Post-Clouddocs/providerflow/github-post-cloud-validation-runbook.md
Shopify Post-Clouddocs/providerflow/shopify-post-cloud-validation-runbook.md
Twilio Post-Clouddocs/providerflow/twilio-post-cloud-validation-runbook.md

Evidence Templates

TemplatePath
Stripe Evidence Templatedocs/providerflow/evidence-templates/stripe-live-validation-evidence-template.md
GitHub Evidence Templatedocs/providerflow/evidence-templates/github-live-validation-evidence-template.md
Shopify Evidence Templatedocs/providerflow/evidence-templates/shopify-live-validation-evidence-template.md
Twilio Evidence Templatedocs/providerflow/evidence-templates/twilio-live-validation-evidence-template.md
Evidence Schemadocs/providerflow/evidence-templates/provider-live-validation-evidence.schema.json

3. Provider Integration Guides

GuidePathCanonical
Sourcesdocs/guides/sources.md
Endpointsdocs/guides/endpoints.md
Destinationsdocs/guides/destinations.md
Stripe Guidedocs/guides/stripe.md
GitHub Guidedocs/guides/github.md
Shopify Guidedocs/guides/shopify.md
Twilio Guidedocs/guides/twilio.md
Custom Webhooksdocs/guides/custom-webhooks.md
Adaptersdocs/guides/adapters.md
Monitoringdocs/guides/monitoring.md
Cluster Enrollmentdocs/guides/cluster-enrollment.md

4. Security / Public Trust

DocPathCanonical
Security Posture (AI)docs/ai/security-posture.md
V1 Security Validation Summarydocs/ai/v1-security-validation-summary.md
Security Capability Validationdocs/security/security-capability-validation.md
Security Validation Suitedocs/security/security-validation-suite.md
Security Validation V1 Cutlinedocs/security/security-validation-v1-cutline.md
Trust Labdocs/security/trust-lab.md
Trust Scenario Registrydocs/security/trust-scenario-registry.md
V1 Security Readiness Checklistdocs/security/v1-security-readiness-checklist.md
Security Tieringdocs/security/security-tiering.md
Tenant Isolationdocs/security/tenant-isolation.md
IP Allowlistingdocs/security/ip-allowlisting.md
Header Validationdocs/security/header-validation.md
Cryptographic Enrollmentdocs/security/cryptographic-enrollment.md
Secure Webhook Deliverydocs/security/secure-webhook-delivery.md
Webhook Access Controldocs/security/webhook-access-control.md
ZenLock Credential Lifecycledocs/security/zenlock-credential-lifecycle.md
Agent SaaS mTLSdocs/security/agent-saas-mtls.md
Non-Claims (AI)docs/ai/non-claims.md
Public Surface Traceabilitydocs/ai/public-surface-traceability.md
Public Terminology Taxonomydocs/ai/public-terminology-taxonomy.md
AI Overviewdocs/ai/overview.md
Public Docs Claim Auditdocs/evidence/public-docs-claim-audit.mdEvidence
Evidence Non-Claimsdocs/evidence/non-claims.md

5. Fabric

DocPathStatus
Three-Plane Modeldocs/architecture/three-plane-model.mdlocal_ready
Platform Layersdocs/architecture/platform-layers.mdlocal_ready
Delivery Modesdocs/architecture/delivery-modes.mdActive

Fabric Planes and Adapters are tracked in the truth matrix under their respective statuses (local_ready, contract_verified). No dedicated Fabric docs page exists beyond the architecture docs.

6. Billing

DocPathStatus
Billing Termsdocs/legal/billing-terms.mdArchived (draft template)
Plans and Limitsdocs/start-here/plans-and-limits.mdActive
Launch Statusdocs/start-here/launch-status.mdActive

Stripe billing is cloud_gated in the truth matrix. Post-cloud validation of billing requires the control plane deploy first (see post-cloud validation sequence).

7. Cloud / Live Operations

DocPathStatus
Backupsdocs/operations/backups.mdcloud_gated
Troubleshootingdocs/operations/troubleshooting.mdActive
Upgradesdocs/operations/upgrades.mdActive
Gateway API Migrationdocs/networking/gateway-api-migration.mdActive
Prod Revalidation Runbookdocs/runbooks/prod-revalidation.mdActive
Rollback and Abortdocs/runbooks/rollback-and-abort.mdActive
Prod Republishdocs/runbooks/prod-republish.mdActive

8. Guardrails

PolicyLocation
Public Surface Update Policydocs/20-OPERATIONS/PUBLIC_SURFACE_UPDATE_POLICY.md
Canonical Docs Map (this file)docs/README_CANONICAL_DOCS_MAP.md
Docs Consolidation Logdocs/DOCS_CONSOLIDATION_LOG.md
Evidence Navigation Indexdocs/evidence/evidence-index.md
Hooks-only validationzen-platform repo
No .github / workflowsPolicy
Fixed report paths/tmp/docsai-report.{md,json}
No bypass / no force-pushPolicy

9. Archive / Evidence-Only Docs

These are historical or evidence artifacts, or archived docs. They are not active navigation docs and should not be treated as canonical references:

  • docs/80-EVIDENCE/* — All audit evidence (see Evidence Index for classification)
  • docs/evidence/public-docs-claim-audit.{json,md} — Historical claim audit
  • docs/ai/evidence-v1-supersession.md — Supersession log
  • docs/99-ARCHIVE/ — Archived docs (see docs/99-ARCHIVE/ARCHIVE_MANIFEST for details)
  • docs/legal/*.md — Archived as draft templates (all 12 legal docs)
  • docs/mcp/authentication.md — Archived, superseded by authentication-and-mtls.md
  • docs/delivery/replay.md — Superseded by replay-and-recovery.md
  • docs/delivery/deduplication-vs-idempotency.md — Superseded by individual files
  • docs/delivery/replay-vs-retry.md — Superseded by individual files
  • docs/delivery/routing-and-fan-out.md — Superseded by individual files
  • docs/reference/api.md — Superseded by docs/api/*
  • docs/reference/mcp.md — Superseded by docs/mcp/*

Provider Status (Canonical)

ProviderMaturityLive E2ELaunch Gate
Stripeverifiedcloud_gatedNO_GO
GitHubverifiedcloud_gatedNO_GO
Shopifyverifiedcloud_gatedNO_GO
Twilioverifiedcloud_gatedNO_GO

Public launch remains NO_GO until all launch gates pass.