Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Documentation Audit

Audit date: 2026-05-07

Scope

Reviewed all Markdown files in the repository, excluding generated dependency folders and Git internals.

Initial inventory: 142 Markdown files. Final inventory: 138 Markdown files.

Decision Criteria

Documentation was kept when it still serves one of these purposes:

  • current onboarding or local development guidance
  • current operational runbook or release checklist
  • current API, event, feature, model, or deployment contract
  • product direction or strategy that is still useful for planning
  • historical implementation spec that explains why the system exists or how it evolved

Documentation was removed or consolidated when it was:

  • a point-in-time status report with obsolete PR, branch, CI, or deployment state
  • a temporary implementation summary duplicated by canonical specs or current runbooks
  • a duplicate checklist competing with a canonical path
  • likely to mislead engineers about current production behavior

Removed

FileReason
docs/homepage_guest_recommendation_production_checklist.mdStale cross-repository rollout checklist with obsolete PR numbers, branch names, strategy labels, and deployment state. Current release readiness and canary guidance lives in docs/release_readiness_checklist.md and docs/canary_rollout_runbook.md.
specs/001-personalized-hungry-hub/ANALYSIS_REPORT.mdTemporary analysis output superseded by the remaining spec/design files and current docs.
specs/001-personalized-hungry-hub/DEPLOYMENT_CHECKLIST.mdOld deployment checklist with stale status references. Current deployment guidance lives under docs/.
specs/001-personalized-hungry-hub/FINAL_IMPLEMENTATION_SUMMARY.mdPoint-in-time implementation summary superseded by current code and retained design specs.
specs/001-personalized-hungry-hub/IMPLEMENTATION_STATUS.mdObsolete test and implementation status report.
specs/001-personalized-hungry-hub/TEST_FIX_SUMMARY.mdTemporary test-fix note with stale pass/fail counts.
docs/recommendation-implementation-plan.mdPoint-in-time MVP implementation plan superseded by the current serving code, feature-store v2 runbooks, release readiness checklist, and project onboarding docs.
docs/homepage_serving_refactor_rfc.mdDraft refactor RFC superseded by the implemented homepage decision/ranking path, current observability, and production runbooks.

Merged Or Consolidated

ChangeReason
Merged specs/015-recsys-cleanup-simplify/checklists/requirements-quality.md into specs/015-recsys-cleanup-simplify/checklists/requirements.mdKeeps the more complete checklist content while preserving the canonical requirements.md path used by other spec folders.

Updated

FileChange
docs/guest_personalization_prd.mdAdded the PRD and product principle that requirements are hypotheses evaluated by outcome impact.
docs/member_personalization_prd.mdAdded the PRD and the same outcome-over-features product principle.
README.mdAdded quick links to the new documentation index and personalization PRDs.
docs/project_overview.mdClarified that current Tiger/Felidae homepage integration uses /v2/homepage/decide, while /v2/homepage remains the full-generation serving shape.
docs/legal/dsa-compliance.mdFixed the local privacy-policy link.
specs/002-seed-data-script/checklists/requirements.mdFixed the relative link to the spec file.
specs/005-recsys-model-enhancement/checklists/requirements.mdFixed the relative link to the spec file.

Reorganized

ChangeReason
Added docs/README.mdProvides a current documentation index and makes it clear which docs are operational, product, contract, legal, or historical.
Added specs/README.mdClarifies that specs/ is historical design context, not current deployment truth.
Removed stale docs/audit/standardization-simplification-audit.mdThe audit referenced removed Feast v1 modules and obsolete Redis seeding flows.

Kept As-Is

The remaining Markdown files were kept because they fall into one of these maintained categories:

  • root repository metadata: README.md, CHANGELOG.md, MIGRATION.md
  • package or folder READMEs: data/, envs/, k8s/, recsys/contracts/, tests/
  • current product/engineering docs under docs/
  • operations runbooks under docs/runbooks/
  • legal/compliance docs under docs/legal/
  • historical design specs under specs/

Assumptions

  • Historical specs are useful as design records even when their implementation dates are old.
  • Current operational truth should live under docs/, not in historical spec status reports.
  • External links were not crawled; validation focused on local Markdown links and references.
  • No application code changes were needed for this cleanup.