Router.Africa — Documentation Index
One repo, four areas: /product for the business, /architecture for the build decisions and stack, /infra for the Bifrost gateway deployment that implements one piece of it, and /planning for the backlog. Suggested structure below — file names in parentheses are what to rename each document to when you add it.
/docs /product design-doc.md (openrouter-africa-design-doc.md) business-model.md (openrouter-africa-business-model-doc.md) website-copy.md (router-africa-usp-website-copy.md) architecture.svg (router-africa-architecture.svg) openrouter-api-comparison.md (competitive / API-contract reference) pricing-model.md (router-africa-pricing-model.md) dashboard-scope.md (router-africa-dashboard-scope.md) api-docs-scope.md scope of the developer-facing API docs (backlog #10) api-surface.md which endpoints are public at launch (proposed) openrouter-docs-site-audit.md OpenRouter's docs-site features: match, match differently or skip (D.01, draft) design-system/ brand foundation reference (colors, type, icons, mascot) — spec, not the consumable system /architecture decisions-log.md (router-africa-decisions-log.md) <- source of truth for decisions backend-scope.md service map, data map, request flows db-schema.md column-level schema, ER diagrams, hold/settle hot path auth-security.md public API auth (OpenAI-compatible), session hardening, conformance tests api-key-security.md key lifecycle, blast radius, leak detection and response (backlog #15) cicd.md pipelines, gates, ordering rules, migrations, rollback (backlog #13) observability.md signals, alerts, severity tiers, canary, dashboards (backlog #14) network-security-map.md every traffic path and its security gates; wire diagram; open gaps api-errors.md the public API error catalogue: envelope, statuses, reasons, headers (P1.08) future-optimizations.md deferred optimizations + the hooks to build now tech-stack.md (router-africa-tech-stack.md) <- terse "what", no rationale /infra installation-as-built.md (bifrost-installation-as-built.md) <- start here plugins-and-extensibility.md (bifrost-plugins-and-extensibility.md) rancher-todo.md (rancher-setup-TODO.md) secrets-inventory.md every secret by name: where deployed, who holds it, rotation (never values) /execution README.md the build plan: phases, milestones, decisions still needed, working rules phase-<n>-<name>.md one file per phase; tasks with spec, dependencies, done-when and status track-d-developer-docs.md the developer docs track (custom docs app, curated OpenAPI spec), alongside the phases /planning backlog.md (router-africa-planning-backlog.md) <- historical index + status tableBrowse in a browser
Section titled “Browse in a browser”site/ is a small Astro Starlight site with navigation, search and rendered diagrams: cd site && npm install && npm run dev. See site/README.md.
Where to start
Section titled “Where to start”- New to the project?
product/design-doc.md— the problem, architecture, and Niobi payments integration. - Want the business case?
product/business-model.md(partly superseded on pricing — see its banner). - Is anything in the network or security still open?
architecture/network-security-map.md— the wire diagram of every traffic path, with each gate marked decided, pre-launch, or open. - Want to know what’s decided vs. open?
architecture/decisions-log.md— the source of truth for architecture decisions, with rationale and rejected alternatives.architecture/tech-stack.mdis the terse “what’s used” companion; keep rationale out of it. - Working out billing/pricing mechanics?
product/pricing-model.md(daily published rate, FX, markup rules engine). It supersedes the repricing cadence inbusiness-model.md;design-doc.md§5 remains the source of truth for balance semantics. - Building the dashboard?
product/dashboard-scope.md. - What do we build next?
execution/README.md— the phase plan to launch; pick a task whose dependencies are done. - What’s the project plan status?
planning/backlog.md— original 16-item list, annotated with a status table. - Marketing site: built and lives in a separate repo;
product/website-copy.mdis its source copy. - Designing the customer-facing API?
product/openrouter-api-comparison.md— what OpenRouter’s public API does, what Bifrost gives us for free, and what we still have to build. - Writing or planning the developer API docs?
product/api-docs-scope.md— audience, content scope, dependencies, and where it lives (router.africa/docs, hand-written, source in the website repo). - Which endpoints are public?
product/api-surface.md— OpenRouter’s endpoints vs ours, and what we document at launch. - Brand/visual reference?
product/design-system/— the mood-board page (colors, type, icons, mascot). The consumable design system (Tailwind tokens, React components) lives in therouter.africacode repo’spackages/ui-web, not here. - Working on the live server?
infra/installation-as-built.mdis the single source of truth for what’s actually deployed — commands, the validatedvalues.yaml, and the real issues hit during install and how they were fixed. There is no separate “planning” deployment guide anymore; earlier draft guides were removed once they diverged from what was actually built, to avoid anyone following stale, incorrect YAML. - Want to change something about the gateway? Check
infra/plugins-and-extensibility.mdbefore touching source code — most things are avalues.yamlchange. - Setting up Rancher later?
infra/rancher-todo.md.
Notes on file status
Section titled “Notes on file status”- Product docs (
design-doc.md,business-model.md,website-copy.md) are not Bifrost-specific — they describe Router.Africa the product (positioning, pricing, market) independent of which gateway technology implements the routing layer.
Open items across all docs (as of last update)
Section titled “Open items across all docs (as of last update)”Architecture open items are tracked in architecture/decisions-log.md (Open table): currently only the deferred prompt/response retention details (content is opt-in) (see backlog item 17). Deferred optimizations and the hooks that keep them cheap are in architecture/future-optimizations.md. Infra/other items below.
- Provider API keys (OpenAI, Anthropic, Google, Fireworks) not yet added to the live gateway
- Postgres backup job not yet set up
- Rancher import deferred
- Niobi payments/billing ledger integration not yet built — the current deployment is the model-routing layer only. Design is settled: own Postgres ledger, with Bifrost virtual keys (1:1 per API key) for rate limits and budgets (see the decisions log).