Julien Gautier
f776ce732a
Angular CLI's `budgets` only compare RAW sizes — there's no native gzip-mode budget. ADR-0017 specifies thresholds in gzip-transfer terms (initial bundle ≤ 300 KB gzip, any lazy chunk ≤ 100 KB gzip, total stylesheet ≤ 150 KB gzip), so the project.json values today are an approximate raw-size translation. The follow-up flagged in ADR-0017's confirmation list — a CI check that asserts the actual gzipped transfer size — lands here. `scripts/check-gzip-budgets.mjs`: - Parses Angular's emitted index.html to separate initial assets (anything referenced via src=/href=) from lazy chunks (the rest). - Gzips every JS / CSS file at level 9 — what most HTTP servers serve for static assets — and reports a per-file + per-bucket size table. - Compares against the ADR-0017 budgets and exits non-zero on any breach. Plain Node, no deps; ~120 lines. Wired through: - `pnpm ci:gzip-budgets` invokes the script with the default dist path (`dist/apps/portal-shell/browser`). - `ci:perf` chains build → gzip check → Lighthouse, so a budget breach short-circuits before Lighthouse even runs (saves several minutes on a failing PR). ADR-0017 §Confirmation updated: the previous "future follow-up will add a CI check" line is replaced by a description of how the script works, with a link to it. Verified locally on the production build: - Initial JS total: 92.88 KB / 300 KB budget ✓ - Lazy chunks largest: 1.38 KB / 100 KB per-chunk budget ✓ - CSS total: 3.35 KB / 150 KB budget ✓
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.