crosscue

Crosscue — Documentation Index

Status: Living — update when adding, retiring, or re-homing a doc.

Where docs live: the repo root holds the evergreen project-wide set — what Crosscue is and how to work on it (README, PRODUCT, ARCHITECTURE, MODELS, CONVENTIONS, DEPLOYMENT, CONTRIBUTING, SECURITY). docs/ holds everything decision-shaped, dated, or operational: ADRs, design docs, runbooks, QA checklists, policies, and reviews. Component-local READMEs (crosscue/backend/challenge_boards/, deeplinks/) stay next to their code.

Status convention: every doc under docs/ carries a status line — Living (kept current; edit in place), Snapshot (date) (point-in-time; never edited — corrections land in living docs), or Historical (plan of record for shipped/superseded work).

Product & policy

• Privacy Policy — is the published privacy.html filed with both stores: GitHub Pages builds main:/docs via Jekyll and serves it automatically (verify the live page after policy changes — DEPLOYMENT.md store checklists)
• Delete your Crosscue data — is the published delete-data.html, the dedicated data-deletion page filed as the Play Console “Delete data URL” (same publish/verify rule as the policy)
• Product vision & principles — why the app exists, the online-feature rule, roadmap themes, non-goals
• Security policy — vulnerability disclosure

Architecture (docs/architecture/)

• Decisions (ADRs) — one file per decision; the index lists all sixteen
• Compatibility matrix — the five versioned contracts, support windows, Crosshare dependency policy (Living)
• Threat model — trust boundaries, defended threats, accepted risks (Living)
• Completion data authority — who owns live vs. historical solve state (Living; ADR-0008)
• Sync design — orchestrator/adapter/transport layers, merge rules, wire format (Living; ADR-0009)
• Rebus entry — implementation plan (Historical — shipped; ADR-0010)
• iOS App Intents — Shortcuts/Siri/ Spotlight runbook (Living)
• iOS widget setup — WidgetKit one-time setup + payload schema (Living)
• iCloud sync setup — Apple-side one-time setup + verification (Living)
• Google Drive sync setup — OAuth client setup (Living)

QA (docs/qa/)

• iOS release checklist (Living)
• Android release checklist (Living)

Reviews & plans (point-in-time)

• Design & architecture review (Snapshot 2026-06-11) — planning-level review that produced PRODUCT.md, the ADR system, compatibility.md, and the threat model
• Code review (Living tracker until findings close) — style/security/cloud findings with resolution status
• App analysis (Snapshot 2026-06-07) — gap analysis: issues, findings F1–F7, parity P1–P4
• Challenge Boards #159 breakdown (Living tracker — flips Historical when #159 closes)
• bug-evidence/ — screenshots referenced by issues

Component docs (live with their code)

• Challenge Boards Worker — Cloudflare backend setup; API contract
• Invite deep links — AASA/assetlinks hosting + QA matrix