Skip to main content

ADR 0001 — Docs stack

  • Status: Accepted
  • Date: 2026-06-22

Context​

The engine repo (avuru-obs) keeps documentation as in-repo Markdown. We need a public docs website with a low-friction contribution flow, without coupling docs releases to engine releases.

Decision​

  • Docusaurus 3 (MDX, i18n, versioning-ready) as the framework.
  • A separate repo (avuru-obs-doc) so docs PRs don't gate the engine.
  • Hostinger static hosting, published by a GitHub Action over FTPS on every push to main.
  • English is the canonical locale; French is maintained alongside it.

Consequences​

  • "Edit this page" → 3-click PR; the home page proves the install promise.
  • A front-matter linter replaces most manual style review.
  • Preview deploys (Vercel/Netlify) are optional and not wired in v1; the CI build is the PR gate.

This is the example ADR. Copy templates/adr.mdx for new ones.