docs.raxx.app — v1 Public Organization Plan
Status: Planning
Date: 2026-05-28 UTC
Owner: operator / ux-polisher
Parent issue: #2680
Parent epic: #2678
Scaffold design: docs/architecture/docs-site-scaffold-2026-05-15.md
ADR: docs/architecture/adr/0088-docs-site-tooling-choice.md
1. Scope
This document is a layout and index deliverable — it does not write new content.
It organizes what exists in docs/customer/ for v1 public consumption and identifies
content that needs operator review before launch-day (FLAG_SC_D14 noindex flip).
2. Existing content inventory
All files live in docs/customer/. These feed the static build via
scripts/build-customer-docs.py and ship at docs.raxx.app.
| File | Current heading | Status |
|---|---|---|
index.md |
"Raxx Documentation" | Good — landing + nav hub |
getting-started.md |
"Getting started with Raxx" | Good — signup to first paper trade |
concepts.md |
"Core concepts" | Good — four platform concepts |
broker-setup.md |
"Broker setup" | Good — broker connection walkthrough |
pricing.md |
"Pricing" | Needs operator review — TBD markers present; prices not final |
faq.md |
"FAQ" | Good — 10+ entries |
privacy-terms.md |
"Privacy Policy and Terms of Service" | Good — navigational mirror only |
troubleshooting.md |
"Troubleshooting" | Good — error-by-error guide |
account-merging.md |
"How account merging works" | Good — CS-initiated merge process, verification flow, reversal policy. Gated by FLAG_ACCOUNT_MERGE (#3245). Links to Privacy Policy §7b. |
3. Proposed top-level navigation
Two-click rule: a first-time visitor must reach Getting Started, Core concepts, or Troubleshooting within two clicks from the landing page.
docs.raxx.app/
├── / ← index.md ("Raxx Documentation" landing)
│
├── Getting started ← getting-started.md
│
├── Setup
│ └── Broker setup ← broker-setup.md
│
├── Platform concepts ← concepts.md
│
├── FAQ ← faq.md
│
├── Troubleshooting ← troubleshooting.md
│
├── Account management
│ └── Account merging ← account-merging.md (gated by FLAG_ACCOUNT_MERGE; refs #3252)
│
├── Pricing ← pricing.md [needs operator review — TBD markers]
│
└── Legal ← privacy-terms.md (links to raxx.app/privacy + raxx.app/terms)
Rationale for "Setup" grouping: broker-setup.md is a single page today. If
strategy-setup.md ships post-v1, it slots under Setup without changing the top nav.
4. Navigation items that need operator review
These items exist in the content but have unresolved TBD markers or
data-brand-placeholder copy that needs a content decision before launch.
| Page | Issue | Needed before launch? |
|---|---|---|
pricing.md |
Contains explicit <!-- TBD: confirm with Kristerpher... --> comment; pricing amounts not finalized per project_pricing_tiers_locked (Free / Pro / Pro+ locked, but Pro / Pro+ prices pending BLR research) |
Yes — either fill prices or omit the page from nav until confirmed |
| All pages | data-brand-placeholder taglines / pillars still use filler copy; formal brand deferred to ~2026-11 |
Acceptable for v1 per project_brand_six_month_defer |
index.md |
Nav link text for "Setup" section not yet in file (currently just a link to broker-setup.md inline) |
Low risk — update during the ux-polisher pass |
5. Link audit — pages to check
These links appear in index.md and must resolve to HTTP 200 before the noindex
flip (SC-D14).
| Linked path | Target file | Check |
|---|---|---|
/getting-started/ |
getting-started.md |
Verify build output path |
/concepts/ |
concepts.md |
Verify build output path |
/broker-setup/ |
broker-setup.md |
Verify build output path |
/faq/ |
faq.md |
Verify build output path |
/troubleshooting/ |
troubleshooting.md |
Verify build output path |
/pricing/ |
pricing.md |
Verify build output path; content TBD |
/privacy-terms/ |
privacy-terms.md |
Verify build output path |
/account-merging/ |
account-merging.md |
Verify build output path; only rendered when FLAG_ACCOUNT_MERGE is ON |
raxx.app/privacy |
External (raxx.app) | Verify live URL exists |
raxx.app/privacy#account-merging |
External (raxx.app anchor) | Verify anchor resolves once §7b lands |
raxx.app/terms |
External (raxx.app) | Verify live URL exists |
6. CE visual palette — what to apply
Per feedback_all_surfaces_confidence_engine and the ux-polisher card scope:
- Replace any Bootstrap-default blue (
#007bff) withvar(--raxx-moss)orvar(--raxx-ink) - Replace gray backgrounds with
var(--raxx-bg)(dark) orvar(--raxx-bg-surface) - Apply
var(--raxx-font-sans)body type,var(--raxx-font-mono)for code blocks - Single
h1per page — verified by link checker gate in CI - No skipped heading levels (
h2→h4) - Moss-pill live/status indicator if a "Platform status" link is added to the nav
The ux-polisher pass applies palette changes; it does not rewrite content.
7. Pages that do NOT exist at v1 (excluded from build manifest)
Per docs/architecture/docs-site-scaffold-2026-05-15.md §3 "Non-goals":
- API reference — no public API at v1; excluded from build
- Release notes — depends on #99 (semver + GitHub Releases); deferred post-v1
- Search — client-side search deferred post-v1
- Localization (fr-CA) — Quebec geo-blocked at signup; deferred until Canadian customers are accepted
- Video embeds — Phase 2+ content work
8. Ordering decision for ux-polisher
- Run the link checker against the current build output — identify any broken internal links or unreachable pages.
- Apply CE palette to all 8 pages (nav chrome + body chrome — leave content text alone).
- Update
index.mdnav links to reflect the "Setup" grouping if sub-pages expand. - Flag
pricing.mdTBD markers to operator for a content decision; do not remove the page from the nav unilaterally. - Post the change log comment on issue #2680 listing every file touched.
- File operator-decision items (pricing content, any dead external links) as
needs:operator-decisionlabels rather than blocking the PR.
9. Operator-review items (summary)
| Item | Needs operator review | Blocking launch? |
|---|---|---|
pricing.md TBD markers — Pro / Pro+ prices |
Yes | Yes — either populate or omit from nav |
raxx.app/privacy + raxx.app/terms live URLs |
Yes | Yes — linked from privacy-terms.md |
"Setup" sub-section nav text in index.md |
No — ux-polisher can write it | No |
| Brand placeholder copy (taglines, pillars) | No — deferred ~2026-11 | No |