Julien Gautier
eebe20bc6f
Records the decision to render `docs/**/*.md` as a separately-deployed static site using VitePress (Vite-based, Node-only toolchain) with `vitepress-plugin-mermaid` for the existing C4 + sequence diagrams. Site mapping: docs/index.md (new, Hero layout) → / docs/development.md → /development docs/architecture.md → /architecture docs/decisions/README.md → /decisions/ docs/decisions/00NN-…md → /decisions/00NN-… (auto sidebar) docs/setup/0N-…md → /setup/0N-… `docs/README.md` stays as the git-side / IDE-preview index and is excluded from the published site. `docs/decisions/template.md` is likewise excluded — authoring scaffold, not reader content. Audience is internal (RSSI, devs, ops). Surfacing inside portal-admin was considered and rejected — ADR-0020 §"Audience is disjoint" frames portal-admin around operational workloads, not architecture review. A decoupled site keeps the boundary clean. Toolchain alignment is the deciding factor over MkDocs Material: adding a Python runtime to Gitea Actions is a permanent maintenance tax we can avoid by reusing the Vite stack already in the workspace. Docusaurus + Astro Starlight are documented in "Pros and cons" as runner-up + revisit-later options. Implementation lands as a separate chantier (`.vitepress/config.ts`, `docs/index.md`, Gitea Actions workflow, `package.json` scripts).
Documentation index
This is the entry point to all project documentation. It is maintained automatically: any addition, rename, or removal of a .md file under docs/ must be reflected here in the same change.
Conventions
- Documentation is written in English.
- One topic per file. Group related files into a folder when there are three or more.
- Cross-reference with relative links so they keep working in GitHub, IDEs, and exported sites.
- For architectural decisions, do not add them here — they belong in decisions/ as MADR 4.0.0 ADRs.
Sections
Daily development
- development.md — repo layout, prerequisites, initial setup, daily commands, observability dev-loop (Jaeger UI, log ↔ trace correlation), dependency updates (Renovate), conventional commit cycle. Day-to-day reference for working on the project.
Architecture
- architecture.md — cross-cutting Mermaid diagrams: C4 system context, C4 containers, Nx module boundaries, CI/CD pipeline. Single-decision diagrams (auth sequence, ERD, etc.) live inline in their ADR.
Onboarding & environment
Setup guides for new contributors:
- setup/01-wsl-terminal-setup.md — modern WSL terminal (Zsh + Powerlevel10k + CLI tools)
- setup/02-dev-web-stack.md — Node via nvm, pnpm via corepack, Docker
- setup/03-angular-nx-monorepo.md — Angular + Nx monorepo bootstrap
Operations & runbooks
Empty — to be populated when we deploy.
Security, performance, accessibility
Empty — placeholders to be filled with rationale docs alongside their corresponding ADRs.