| title | Project Documentation |
|---|
Purpose
- Provide the routing map for project documentation.
Retirement Notice
- This repo is retired for live Odoo runtime, deploy, restore, bootstrap, promotion, rollback, preview, and secret-management work.
- Use Launchplane for shared/testing/prod mutations and durable runtime
authority, tenant repos for tenant addon/workflow ownership,
odoo-devkitfor manifest-backed local runtime DX and artifact handoff, and Odoo image repos for runtime image construction. - Docs below this index are historical unless they explicitly point to one of
those current owners. Do not treat repo-local
uv run platformexamples here as current production guidance.
When
- At the start of any task to pick the right handles.
Routing
- Start a change: @docs/workflows/codex-workflow.md
- Workflow playbooks: @docs/workflows/debugging.md, @docs/workflows/refactor.md, @docs/workflows/multi-project.md, @docs/workflows/prod-deploy.md
- Testing flow: @docs/TESTING.md
- Testing commands: @docs/tooling/testing-cli.md
- Reviews and gate: @docs/policies/acceptance-gate.md, @docs/tooling/inspection.md
- Documentation style: @docs/policies/doc-style.md
- Odoo canon: @docs/odoo/workflow.md, @docs/odoo/orm.md, @docs/odoo/security.md, @docs/odoo/performance.md, @docs/odoo/external-ids.md
- Style: @docs/style/index.md (then @docs/style/python.md, @docs/style/javascript.md, @docs/style/testing.md, @docs/style/browser-automation.md)
- Integrations: @docs/integrations/README.md (Shopify: @docs/integrations/shopify.md, Authentik: @docs/integrations/authentik.md, eBay: @docs/integrations/ebay.md)
- Data sources: @docs/data-sources/README.md
- Tooling: @docs/tooling/codex-cli.md, @docs/tooling/odoo-intelligence.md, @docs/tooling/secrets.md, @docs/tooling/gpt-service-user.md, @docs/tooling/runtime-baselines.md, @docs/tooling/db-tuning.md, @docs/tooling/gate-benchmark.md, @docs/tooling/image-contracts.md, @docs/tooling/chris-testing-runner.md, @docs/tooling/docker.md, @docs/tooling/cm-seeds.md
- Architecture: @docs/ARCHITECTURE.md, @docs/control-plane-roadmap.md, @docs/resources.md
- Roles: @docs/roles.md
- Platform migration status: @docs/todo/platform-migration-status.md
Archived Platform Docs
- @docs/tooling/platform-cli.md,
@docs/tooling/platform-command-patterns.md,
and @docs/tooling/dokploy.md describe retired
odoo-aiplatform behavior. They are retained for historical reference only; current live authority belongs to Launchplane, tenant repos, image repos, andodoo-devkit.
Notes
- Keep docs small; prefer linking by handle to larger guides when needed.
- Tenant-specific rollout notes should live in the tenant repo docs, not this shared index.
- The CM import baseline now lives in
odoo-tenant-cm/docs/todo/rather than this shared index. docs/internal/is intentionally excluded from this index; it is a local, gitignored workspace for sensitive or instance-specific notes.