Julien Gautier
e1805f596d
`audit.html` and `users.html` cited ADR-0013 / ADR-0020 with anchors pointing at `https://github.com/adr/madr` — that's the MADR _template_ repository, not our ADRs. Copy-paste artifact from the original authoring. Both links now resolve to the actual ADR file on Gitea (`https://git.unespace.com/julien/apf_portal/src/branch/main/docs/decisions/…`) so a reviewer who clicks lands on the right document. Surfacing the ADRs inside portal-admin is intentionally out of scope — the audience (APF internal admins, not architects) doesn't justify the markdown-rendering + BFF-filesystem coupling cost; a separate static- site for docs is a better fit and lands as its own chantier.
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.