Canonical content map¶
This page defines where the single source of truth lives for topics that tend to get duplicated.
Use it when writing new pages or reviewing PRs.
Rules¶
- Each topic has one canonical page.
- Other pages may link to the canonical page, but must not re-explain it.
- Duplicate content is allowed only for:
- very short summaries (2–3 bullets)
- “role-based” re-framing (business vs dev) that points to the canonical page
- checklists that link to the canonical explanation/reference
Canonical pages¶
Product positioning / buyer flow¶
- “What is RecSys?”: What the RecSys suite is (stakeholder overview)
- Buyer journey: Buyer journey: evaluate RecSys in 5 minutes
- Evaluation + licensing: Evaluation, pricing, and licensing (buyer guide)
Integration contracts¶
- Integration contract (headers, tenancy, request_id, invariants): Integration spec (one surface)
- Data contracts hub: Data contracts
- Minimum instrumentation spec: Minimum instrumentation spec (for credible evaluation)
Evaluation and decisions¶
- Suite workflow (ship/hold/rollback): How-to: run evaluation and make ship decisions
- Evaluation validity: Evaluation validity
- Evaluation modes: Evaluation modes
Operations¶
- Operational reliability and rollback: Operational reliability and rollback
- Runbooks hub: Operations
- Baseline benchmarks (ops): Baseline benchmarks (anchor numbers)
Suite architecture¶
- Architecture and data flow (canonical): How it works: architecture and data flow
- Component boundaries and responsibilities: Suite architecture
- Data modes: Data modes: DB-only vs artifact/manifest
- Artifacts + manifest lifecycle: Artifacts and manifest lifecycle (pipelines → service)
Read next¶
- Docs style: Documentation style guide
- How to contribute: Contributing