Raxx Internal Docs
This is the front door for the Raxx (TradeMasterAPI) documentation tree. Everything an
agent, contractor, or operator needs to understand how the platform is designed, run,
secured, and shipped lives under docs/. Start here, follow the quick-nav table to the
area you need, and you should be oriented in under a minute. A taxonomy cleanup is in
progress (see architecture/2026-06-10-docs-taxonomy.md);
the first consolidation pass has merged several near-synonym directories into their
canonical homes, and every link on this page points at a path that exists today.
Start here
- Surface map —
architecture/cloudflare-pages-projects.md: the inventory of Cloudflare Pages projects and the surfaces they back. - Runbook index —
ops/runbooks/README.md: every operational runbook, grouped by failure domain. - ADRs —
architecture/adr/: architecture decision records. Note: the ADR sequence currently has 13 number collisions (two files sharing one number); the renumber repair is tracked as a discrete sub-card and is not yet complete, so a handful of numbers appear twice. See the taxonomy doc §6 for the repair plan.
Quick navigation
| Directory | What lives here |
|---|---|
architecture/ |
System design, ADRs (adr/), surface maps, and cross-service design docs. The canonical "how is this built" home. |
ops/ |
Operations: runbooks (ops/runbooks/), incidents (ops/incidents/), grooming logs (ops/grooming/), sprint + PM planning (ops/pm/), deploy workflows. The canonical ops home. |
security/ |
Security posture, threat models, control baselines, and secret-handling guidance. |
detections/ |
Behavioral detection rule catalogue (login anomalies, signup velocity, abuse patterns). |
agents/ |
Agent operating docs — runbooks and conventions for the autonomous agent fleet. |
sdlc/ |
Software development lifecycle — local setup, testing, conventions, and engineering process. |
qa/ |
QA workflows, acceptance-validation notes, and end-to-end test guidance. |
testing/ |
Testing notes and harness documentation. |
data-science/ |
Quantitative strategy research — signal models, backtests, and handoff packets. |
research/ |
One-off research write-ups (vendor comparisons, technical investigations). |
blr/ |
Business-legal-researcher outputs — trademark, entity, tax, and compliance research. |
business/ |
Business operations, bookkeeping, brand, partner-facing material, and legal research (business/legal-research/). |
finance/ |
Finance docs — chart of accounts, budgets, and burn tracking. |
legal/ |
Legal + compliance artifacts — GDPR posture, DPAs, jurisdiction blocks. |
rbac/ |
Role-based access control model — roles, groups, and groups.yaml design. |
customer/ |
Public-facing customer documentation source. |
marketing/ |
Marketing strategy — pricing, positioning, messaging, launch narrative. |
design/ |
UX/visual design artifacts and mockups (Confidence Engine direction); absorbs the former ux/ and ux-mockups/ trees. |
product/ |
Product specs and feature definitions. |
pm/ |
Project-management artifacts and planning notes. |
launch/ |
Launch planning and cutover material. |
release/, release_notes/ |
Release planning and published release notes. |
decisions/ |
Standalone decision records (being folded into architecture/). |
demo/ |
Demo-environment notes and snapshots. |
console/ |
Console-app-specific operational docs. |
secrets/ |
Secret-handling notes (being merged into security/). |
data/ |
Data-model and dataset notes. |
operations/ |
Legacy ops notes (superseded by ops/). |
morning-brief/ |
Daily morning-brief snapshots. |
templates/ |
Reusable doc + report templates. |
Notable top-level files
| File | What it is |
|---|---|
API.md |
API reference. |
API_DOCUMENTATION.md |
Extended API documentation. |
DOCUMENTATION_GOVERNANCE.md |
How docs are organized and maintained. |
CI_HEALTH_GATE_RUNBOOK.md |
CI health-gate operating runbook. |
OBSERVABILITY_BASELINE.md |
Observability baseline. |
QA_E2E_WORKFLOW.md |
End-to-end QA workflow. |
SLACK_INTEGRATION.md |
Slack integration notes. |
When you add a new top-level area, add a row to the quick-nav table above so the front door stays current.