Astrix Trading — Internal Documentation
The canonical source of truth for everything Astrix builds, owns, and operates. This portal is the renderer for the
docs/folder of theastrix/product/monoreporepository — every page is one Markdown file in Git.
Where to start
| If you want to… | Read |
|---|---|
| Understand what Astrix is and why | PRD/00-overview |
| Find the engineering ground rules | PRD/17-engineering-standards — the single biggest doc; lives the contract for the agentic team |
| Know which architecture decisions have been ratified | ADR/ — historical record |
| Onboard onto a domain | domains/<domain>/ — per-domain landing page |
| Operate an alert / incident | runbooks/ — every alert links to one |
| Author a new doc | standards/ — templates and contracts |
| Search anything | Use the search bar in the header (top right) — FlexSearch indexes every Markdown file |
The four-tier documentation taxonomy
Per Section 17.2 of the engineering standards:
| Tier | Folder | When | Owner |
|---|---|---|---|
| PRD | PRD/ | What we're building and why (the product spec) | Founder |
| TDD | TDD/ | How we'll build a specific feature (engineering design) | Founder + agents |
| ADR | ADR/ | Architecture decision points captured during implementation | Engineer / agent |
| Runbook + Postmortem | runbooks/, postmortems/ | How we operate it; what we learned when it broke | On-call |
Every change to the codebase must update one of these tiers. CI gates at scripts/check-*.ts enforce the contract — see standards/ for the full list.
Conventions
- Markdown is the source. This portal is a renderer; nothing here is hand-edited HTML.
- Edit on GitLab. Every page has an "Edit this page" link in the bottom-right that opens GitLab's web editor.
- Auto-deploy. A push to
mainrebuilds the portal; the change is live athttps://docs.dev.astrixtrading.comwithin ~5 minutes. - Every claim has a source. PRD facts cite open-question rulings (Q-#); ADRs cite the PRD chapter or prior ADR they refine; runbooks cite the alert they cover.
Phase 0 status
This portal is operational as of May 2026. The docs/ folder is the early state of a Phase-0 substrate bootstrap:
- The full PRD (16 chapters + appendix) is locked.
- Section 17 — engineering standards is locked.
- 4 ADRs are accepted (modular monolith; testing/coverage; observability stack; agent-assisted on-call).
- 3 example runbooks are authored against real alerts.
- The TDD folder is empty until Phase 1a (first apps/* lands).
- Postmortems are empty (we have no incidents yet).
For a one-page recap of what's done and what's next, see standards/quick-reference.