Appearance
Per-repo docs — discoverability index
This page indexes the documentation that lives inside each repo, not in this documentation/ site. Use it when you want the operator reference, the build plan, or the per-PR engineering log for a specific service.
The split is intentional:
- Pages in this site (
documentation/guide/{fr,en}/…) are the cross-cutting narrative — architecture overviews that span multiple repos, decision records, comparison docs, migration stories. They change when a story changes. - Per-repo docs are operator + contributor references tied to the code they describe — env vars, route shapes, error codes, build plans, branching rules, CHANGELOG / DONE / TODO living logs. They change in the same PR as the code.
If you're a new contributor: start here, then jump into the repo-specific docs the index points to.
poc-tcg-collector — React Native Android POC
github.com/snag-tcg/poc-tcg-collector
The user-facing scanner app. RN 0.84.1 JS / 0.73.6 Android-native, TypeScript strict, Hermes, single-user POC, local-first.
| Doc | What it covers |
|---|---|
| README.md | Project entry point — what the POC is, quick-start link |
| CLAUDE.md | Agent team contract — Angelo / Mamo / Manu / Milana / Zaher roles, review gate, hard rules |
| AGENTS.md | Same contract for the Codex CLI (parallel to CLAUDE.md, not a duplicate) |
| doc/RUN.md | Clone-to-scanning guide — three run paths, verification |
| doc/POC_NARRATIVE.md | The "why we build" — persona (sealed investor), demo flow, competitor gap |
| doc/POC_BUILD_PLAN.md | Sprint breakdown, task schedule |
| doc/INFRA.md | Hetzner VPS backend infrastructure decisions, locked |
| doc/SCANNER.md | On-device scanner pipeline — src/scan/…, card detection, perspective warp |
| doc/SCAN_FLOW.md | Step-by-step scan flow from capture to result |
| doc/BACKEND_SCAN.md | How the app calls each backend scan endpoint |
| doc/SCHEMA.md | Card / collection / portfolio data model |
| doc/COMPETITORS_OVERVIEW.md | ~100 entities inventoried across 7 categories, threat matrix |
| doc/COMPETITOR_DATA_SOURCES.md | Per-TCG data-source inventory (Scryfall, OPTCG API, Lorcast, etc.) |
| doc/HOW_WE_STAND_OUT.md | Positioning vs competitors |
| doc/POKEMON_API_REVIEW.md | TCGdex / PokémonTCG.io / pokeapi.co evaluation |
| doc/PTCG_ASSETS_REVIEW.md | Image assets evaluation |
| doc/BOILERPLATE_SETUP.md | Build toolchain, Metro / Babel config, the deliberate React/RN version mismatch |
| doc/VPS_CLAUDE_SETUP.md | Setting up Claude Code on the VPS |
| doc/CHANGELOG.md | Per-PR engineering log (living doc, updated every PR) |
| doc/DONE.md | What has shipped (living doc) |
| doc/TODO.md | What's next (living doc) |
| doc/competitor-watch/ | Dated weekly competitor scans |
| doc/lp-winners-watch/ | Dated landing-page winners scans |
French translations of user-facing docs live under doc.bkk/.
tcg-collector-backend — Fastify API + ingest + scan endpoints
github.com/snag-tcg/tcg-collector-backend
Node 22 + TypeScript backend on Hetzner VPS. Fastify HTTP API, idempotent ingest worker, embeddings sidecar (Python + DINOv2-small), Postgres 16 with pgvector, nginx front door.
| Doc | What it covers |
|---|---|
| README.md | Project entry point |
| CLAUDE.md | Repository status, commands, branching conventions |
| docs/ARCHITECTURE.md | Mermaid diagrams — Docker stack, request sequences, DB schema (ERD), auth state machine |
| docs/BACKEND.md | Endpoint reference (/cards, /sets, /stats, /audit, /healthz, /metrics) |
| docs/SCAN.md | POST /scan operator reference — request/response, error codes, OCR pipeline, vision-embedding pipeline, security invariants, troubleshooting |
| docs/RUNNING.md | Bring the stack up — Docker compose recipes |
| docs/OPERATIONS.md | Ops runbook — long-running ingests, backups, recovery |
| docs/INGEST.md | Unified ingest runbook — pipeline, fire-and-forget + since modes, per-TCG sources (Pokémon/TCGdex with multi-language, One Piece/OPTCG, Magic/Scryfall), Option B per-language storage roadmap |
| docs/ROADMAP.md | Backend roadmap (lives on docs/… branches only — see CLAUDE.md) |
| docs/scanner/ | Scanner deep-dives: TCG_VISION.md, SCANNER_ACCURACY_OPTIONS.md, SCAN_PATHS.md, BACKEND_SCAN.md, COMPETITOR_SCAN_ARCHITECTURE.md, POKEMON_CARD_SCANNING_PRIMER.md, ingest pipeline, etc. |
| docs/features/next.md | Upcoming feature notes |
| CHANGELOG.md | Per-release engineering log |
| PROGRESS.md | What's in flight right now |
| DONE.md | What has shipped |
| TODO.md | What's next |
| PRODUCT.md | Product-side context |
| DESIGN.md | Design tokens / Cardex admin UI handoff |
Branching note: per backend
CLAUDE.md,CHANGELOG.md,PROGRESS.md, anddocs/ROADMAP.mdonly land ondocs/…branches, never on feature branches.
routines — Go monorepo for competitor-signal routines
Go multi-binary repo. Each routine is a binary, packaged as a distroless Docker service, fired by VPS cron. Writes dated bilingual EN/FR reports under out/. No database, no LLM API, no queue.
| Doc | What it covers |
|---|---|
| README.md | Project entry point — routine list, quick-start |
| doc/ARCHITECTURE.md | Go monorepo layout, binary structure, C4 diagrams |
| doc/DEPLOYMENT.md | VPS setup, Docker, cron scheduling (French) |
| doc/BRAINSTORM.md / .fr.md | Living doc — future routine ideas, status tracking |
| doc/competitor-watch/ | Competitor-watch sub-doc |
tgc-app — Tormknd's reference scanner app
github.com/Tormknd/tgc-app (upstream; pinned commit baked into our tcg-vision container)
Reference Python + FastAPI scanner using DINOv2 ViT-S/14 + FAISS. We cloned it as the basis for tcg-vision, our scan-comp sidecar.
| Doc | What it covers |
|---|---|
| README.md | Tormknd's project entry point |
| BACKEND_SPECS.md | Frozen ML implementation spec — FastAPI, FAISS, OpenCV preprocessing, perspective transform |
For our adaptation, see scan-comp and tcg-collector-backend/docs/scanner/TCG_VISION.md.
create-best-product — niche-agnostic competitor-intel toolkit
github.com/snag-tcg/create-best-product
A self-hosted Go toolkit that mines 1-star reviews + Reddit complaints + new-entrant signals to feed a product roadmap. Standalone — has its own README/BUSINESS/HONEST_TAKE narrative because it's intended to be cloneable. The TCG collector setup is preserved as an example under examples/tcg/.
| Doc | What it covers |
|---|---|
| README.md / .fr.md | Project entry point + value proposition (bilingual) |
| doc/ARCHITECTURE.md | Toolkit architecture, Go monorepo layout |
| doc/DEPLOYMENT.md | Docker setup, cron scheduling |
| doc/BRAINSTORM.md / .fr.md | Future-routine living doc |
| doc/BUSINESS.md / .fr.md | Honest take on selling this — three viable paths, market positioning |
| doc/HONEST_TAKE.md / .fr.md | Honest assessment, no marketing varnish |
| doc/ADAPT_TO_YOUR_NICHE.md / .fr.md | How to customize the theme catalog for a different niche |
frontend — public marketing site
| Doc | What it covers |
|---|---|
| README.md | Setup + run instructions |
How to keep this page useful
When a new repo-side doc is added, append a row to the right table here in the same PR. When a doc is renamed or removed, update or drop the row. The page is not exhaustive — competitor-watch dated reports, design-handoff assets, and other generated artefacts are linked at the folder level rather than per-file.
When in doubt about whether a new doc belongs in this site or in a repo, ask:
- Cross-repo, story-shaped, would I link this from a roadmap? →
documentation/guide/{fr,en}/ - Tied to specific code paths, env vars, route shapes, or living logs? → in-repo
doc/ordocs/