Team docs

Everything in one place

Every design doc, flow and diagram for the team, indexed. Product docs describe what the product does and why; engineering docs are the contracts and standards the code is built against.

Product docs

Status board

What is done, what is half done and what is still to do across the whole platform, with a priority on each line. Start here before planning any work.

4 sections · Last updated Oct 26, 2026 · status.md

End-to-end flow

Who does what, in what order, from an advertiser signing up to the next-morning report — plus links, metrics, booking, bidding, failures, OTP, AI and the native player.

12 sections · Last updated Oct 23, 2026 · flow.md

UI/UX analysis and plan

Where the three web surfaces stand, what the reference dashboards do better, the new information architecture, and the page-by-page restructure with its rollout.

9 sections · Last updated Oct 22, 2026 · ui-plan.md

What blocks launch

The half-done and to-do lines marked Now: OTP delivery, secret rotation, online billing, security review, QA sweep, error tracking, legal pages, password reset, backups.

From the status board · Oct 26, 2026

Diagrams

All the drawings from the docs on one page, each with a one-line reading and a link back to its section.

9 diagrams

Links and logins

Where everything runs, which page each role uses, and the demo accounts: the Links section of the end-to-end flow.

From the flow doc · Oct 23, 2026

Mall pitch deck

Ten slides for a mall meeting, with a live revenue share example, presenter notes and print to PDF.

Arrow keys to present · P for notes

For AI tools and scripts

Every doc is also served as plain markdown, so an AI assistant or a script can read it in one request instead of crawling the pages.

llms.txt

The index: one line per doc with its markdown link. Give this URL to any AI tool first.

19 docs listed

llms-full.txt

Every doc in one file, in index order, with each diagram described in place. Paste the URL into Claude, ChatGPT or Cursor and ask away.

One file, all docs

Engineering docs

Copied from the repo’s docs/ folder at build time.

API contract

The v1 HTTP contract both the FastAPI backend and the web app are built against.

30 sections · Last updated Oct 31, 2026 · repo/api-contract.md

Cricket design

Hit for Six — the cricket wall, the kiosk, the code, the dice and the prize bands.

8 sections · Last updated Oct 20, 2018 · repo/cricket-design.md

Cricket storyboards

Every ball on the wall as a three-beat scene, and what the commentator says.

5 sections · Last updated Oct 20, 2018 · repo/cricket-storyboards.md

Deploy

How the backend (Railway) and the web app (Vercel) ship from one GitHub repo.

6 sections · Last updated Oct 26, 2026 · repo/deploy.md

Design doc

The locked premises and the system design the platform was built on.

6 sections · Last updated Aug 27, 2026 · repo/design-doc.md

Mobile spec

One Flutter app for both advertisers and ops, role-gated at runtime.

4 sections · Last updated Oct 20, 2018 · repo/mobile-spec.md

Native player plan

The software installed on the screen device: shells per platform, registration, offline, updates, hardware and the build order.

15 sections · Last updated Oct 26, 2026 · repo/native-player-plan.md

Reference sites

Copy and design inventory of the sites the marketing site is modelled on.

31 sections · Last updated Aug 27, 2026 · repo/reference-sites.md

Secrets rotation

How to rotate the Railway secrets without losing wallet phones or locking anyone out, in the right order.

5 sections · Last updated Oct 24, 2026 · repo/secrets-rotation.md

Support and incidents

How advertisers reach us, and the numbered runbooks for a screen down, a wrong ad playing, an OTP outage, a hosting outage and an erasure request.

8 sections · Last updated Oct 24, 2026 · repo/support-and-incidents.md

Backups

Manual Postgres and media-volume backups on Railway, where to store them, the monthly restore drill and the retention rule.

7 sections · Last updated Oct 24, 2026 · repo/backups.md

Player setup

How to make a Windows mini PC, a Mac mini or an Android box open the wall on boot, what the Devices page shows, and the remote fixes.

8 sections · Last updated Oct 20, 2018 · repo/player-setup.md

Testing and CI

How to run the backend tests, the web build and the Playwright journeys locally, and what GitHub Actions runs on every push.

4 sections · Last updated Oct 20, 2018 · repo/testing.md

Uptime and error tracking

The two monitors to create, what to alert on, and how Sentry is wired behind environment variables with no personal data.

5 sections · Last updated Oct 20, 2018 · repo/uptime.md

Product analytics

The events we track on ourselves, the sign-up to first-booking funnel, and days to first booking.

5 sections · Last updated Oct 20, 2018 · repo/analytics.md

UI standard

The one light system: tokens, type scale, registers, and the app shell.

5 sections · Last updated Oct 22, 2026 · repo/ui-standard.md