Docs · Site map

Site map

One file names every page, theme, hotkey, URL value, heading, table, column, message, count line, state word, setting and feature flag. bun run cli site reads it with Bun.markdown (GFM tables and task lists), checks it against the routes and the stylesheet, and writes src/lib/site.gen.ts. The nav, every page title, heading, key hint and table label, the theme switch, both key handlers and every localStorage key come from that file, so a name or key changes here or through the CLI, never in a component.

bun run cli site                                   # check this file, the routes and the generated file
bun run cli site list [pages|themes|keys|urls|sections|tables|columns|messages|stats|states|settings|flags]
bun run cli site set pages /ip name="IP log" nav="IP log"
bun run cli site set keys theme key=c
bun run cli site set settings theme.default value=system
bun run cli site set sections wall.movers title="TOP LINE MOVERS"
bun run cli site set urls "/desk?open=picks" opens="Telegram on its ALGO PICKS tab"
bun run cli site set tables ds.grid label="Odds grid"
bun run cli site set columns market short=MKT
bun run cli site set messages quotes.none text="NO QUOTES YET"
bun run cli site set states status.offline word=OFFLINE
bun run cli site flag theme.contrast off           # untick the box, then regenerate
bun run cli site --write                           # regenerate after a hand edit

bun run cli contract runs the same check, so the pre-commit hook and the gate fail on a stale src/lib/site.gen.ts.

The check also reads every component and route. It fails on a key hint, heading, subtitle, page link label, URL value, storage key, Kpi label, count word or state word written into the code instead of read from here, on a panel name a WebMCP tool writes in its own words, and on a row that nothing renders.

Pages

One name per page. It is the browser title (Name · Sports Operations), the page heading, and the Page column in the goal. Nav is the shorter label in the header. Key jumps to the page from anywhere.

Themes

The order is the order c cycles through. system resolves to dark or light from the operating system, and to contrast when it asks for more contrast.

Hotkeys

global keys work on every page. desk keys work on the desk only and may not reuse a global key. A key never fires while typing in a field, with Ctrl, Alt or Cmd held, or on auto-repeat.

URL state

Every search value a link may carry. /desk drops any value not listed here, screen values must match the screen.* hotkeys, and the check fails on a link in the code whose value is not a row. <id> means any id the page validates itself.

Sections

Every heading and subtitle on a page, as it prints. Components call section("id") (src/lib/sections.ts); {name} is filled in by the component, and a table with the same id takes its label from here, so a panel and its table never have two names. - means none.

Pages

Health

Desk wall

Desk screens and overlays

Tables

Every table and list the user can sort and group, by the id its layout is saved under (desk.table.<id>.v1). The table kit prints the label in its toolbar, so a table is named here and nowhere else, and the check fails on a table id in the code that is not a row.

Columns

Every table column, by the name the code asks for (col("market"), src/lib/columns.ts). One column prints one label on every table: the sort, group and column menus and screen readers use Label. A header narrower than the label prints Short instead (screen readers still hear Label), and widening the column brings the full label back. Phone cards print Short when there is one. A dialog's figure row labels each figure by its column too (<Kpi col="risk" …>), and {name} in a label is filled by the dialog. - means the label always fits.

Messages

Every empty and loading line, by id: what a table, list or panel prints when it has nothing to show. Components call msg("id", vars) (src/lib/messages.ts); {name} is filled in by the component. One text has one row, so two screens that say the same thing share it.

Stats

Every count line: the words printed beside a bold value. Components render <Stat id="…" b={…} v={…} /> (src/components/desk/labels.tsx). A {name} passed in b prints bold, and a missing value prints the empty dash; a {name} passed in v prints plain. The same count reads the same on every screen, so {n} TICKETS is one row.

States

Every status word: the one-word state a pill, chip or source tag prints, and the words a WebMCP tool answers with. A word row is display text, so components read it with state("status.live") (src/lib/states.ts) and a literal "LIVE" in a component or tool fails the check. A value row is a value in the code (a type union, a cutoff), and src/lib/states.test.ts confirms the code answers with exactly those words. One word names one row.

Copy

Every other piece of text a person reads or hears: button and tab labels, options, tooltips, placeholders, screen-reader text and inline words. Components call copy("id") (src/lib/copy.ts); {name} is filled by the component. Text that names a heading, column, count, status or empty state belongs in that table instead. bun run cli site add copy <id> text="…" adds a row in order.