Julien Gautier
e0e090f024
CI / scan (pull_request) Failing after 2m27s
CI / commits (pull_request) Successful in 2m38s
CI / a11y (pull_request) Successful in 1m45s
CI / check (pull_request) Successful in 4m27s
Docs site / build (pull_request) Successful in 2m2s
CI / perf (pull_request) Successful in 4m24s
Implementation of ADR-0022.
* `vitepress`, `vitepress-plugin-mermaid` and `mermaid` added to
workspace devDependencies. Build settled at ~9 s for the full
site, sub-second incremental in dev.
* `docs/.vitepress/config.mts`:
* `srcExclude` drops `docs/README.md` (git/IDE-only index) and
`docs/decisions/template.md` (authoring scaffold).
* `rewrites` maps `decisions/README.md` → `decisions/index.md`
so `/decisions/` resolves to the curated landing while the
source stays git-friendly.
* `ignoreDeadLinks` skips cross-repo refs (`../CLAUDE`,
`../../apps/**`, `../../notes/**`), `localhost:*` dev URLs,
and the deliberately-excluded `README`/`template` references —
the source stays usable from a git/IDE reader without
breaking the site build.
* Auto-generated sub-sidebar for `/decisions` walks
`00NN-*.md` so adding an ADR is one file.
* Mermaid via `withMermaid` with `securityLevel: 'strict'`.
* `docs/index.md` — VitePress Hero landing with four feature
cards (Architecture, Decisions, Development, Onboarding).
* `package.json` exposes `docs:dev`, `docs:build`, `docs:preview`.
* `docs/development.md` (line ~5): `[setup/](setup/)` → first
page, since folder-style links don't resolve cleanly under
`cleanUrls`. Line 330: wrap `${{ github.* }}` in
`<code v-pre>…</code>` so VitePress's Vue template parser
doesn't trip on the curly-brace interpolation.
* `.gitea/workflows/docs-site.yml` — builds on every PR (gate
on parse errors + genuine dead links), uploads the dist as an
artifact on push to main. The Mermaid plugin regression fence
greps for `class="mermaid"` / `<svg>` in ADR-0009's rendered
HTML.
* `.gitignore` excludes `docs/.vitepress/{cache,dist}/`.
Deployment target stays provisional per ADR-0022; the workflow
publishes a `docs-site` artifact for now. The rsync step lands
once the future infrastructure ADR locks the host.
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.