Skip to content

Architecture Principles

These principles align with TOGAF-style guidance and must be referenced whenever the platform evolves.

  1. Value Early Transparency — Internal stakeholders receive timely visibility into roadmap and risks.
  2. Separate Public & Internal Concerns — Marketing content never mixes with sensitive operational detail.
  1. Minimise Data Retention — Collect only anonymous analytics in the marketing site; internal docs store no customer data.
  2. Single Source of Truth — This documentation site captures canonical architecture, decision history, and operational policy.
  1. Client-First Diagrams — Mermaid and D2 render client-side to keep build pipelines simple and reproducible.
  2. Static Before Dynamic — Prefer static generation; introduce Workers or APIs only when a compelling use case emerges.
  1. Docker Consistency — All development workflow runs within Docker to match future automation environments.
  2. Version Independence — Allow apps/site to adopt Astro 6 beta features while apps/docs remains on the Starlight-supported track.
  1. Zero Trust Defaults — Assume every network boundary is hostile; enforce Cloudflare Access for docs before public deployment.
  2. No Secrets in Git — Secrets, API keys, and tokens never enter the repository; use platform-specific secret stores when required.