SailEver docs¶
Start with the architecture: it follows arc42 and links to everything else.
| Folder | What |
|---|---|
architecture/ |
How the system is built and why (arc42, 12 sections). The map to everything below. |
specs/ |
What every product does: the single source of truth for behaviour. |
adr/ |
Architecture decisions and why they were made |
plans/ |
Work that is not built yet |
development/ |
How to build, test and find code: the AGENTS.md files, shown as they are |
glossary.md |
Domain terms; mise doccheck flags the banned ones |
credentials.md |
Where each secret lives (names only) |
infra-map/ |
Interactive map of the infrastructure (generated HTML, committed) |
marketing/ |
Film scripts, pricing |
companion_app/ |
Click dummies of the phone apps (spec: specs/mobile/) |
sltb/ |
SLTB reference encoder and checker (sltb.py, check.py) |
ACTIVITY.fit |
Sample FIT file |
Viewing these docs¶
mise docs # browser, live reload (MkDocs; input: this folder)
mise docs:build # same site into tools/docs/site, --strict: fails on broken links
The HTML is generated and never committed. Cloudflare Pages builds the same site from main and shows it to the owner only.
Rules for agents: AGENTS.md.