Julien Gautier
79eee77594
Set up the foundation for the adastra-portal project: - CLAUDE.md captures durable project rules (quality bar, security/perf/a11y as first-class, language, commit conventions, ADR proactivity). - docs/ and decisions/ scaffolding with maintained indexes (docs/README.md and decisions/README.md), MADR 4.0.0 template, and tag vocabulary. - Phase-1 ADRs (0001-0006) lock structural choices: ADR usage, Nx monorepo with the apps preset, naming convention (adastra-portal / portal-shell / portal-bff), Angular CSR/zoneless/Signals/Vitest, NestJS over Express, PostgreSQL with Prisma. - docs/setup/ guides translated to English. - .gitignore covers Node/Nx artifacts and the personal notes/ scratchpad. The Nx workspace itself is not yet bootstrapped; that step is gated on a revised setup guide aligned with the ADRs.
33 lines
1.2 KiB
Markdown
33 lines
1.2 KiB
Markdown
# 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/](../decisions/) as MADR 4.0.0 ADRs.
|
|
|
|
## Sections
|
|
|
|
### Onboarding & environment
|
|
|
|
Setup guides for new contributors:
|
|
|
|
- [setup/01-wsl-terminal-setup.md](setup/01-wsl-terminal-setup.md) — modern WSL terminal (Zsh + Powerlevel10k + CLI tools)
|
|
- [setup/02-dev-web-stack.md](setup/02-dev-web-stack.md) — Node via nvm, pnpm via corepack, Docker
|
|
- [setup/03-angular-nx-monorepo.md](setup/03-angular-nx-monorepo.md) — Angular + Nx monorepo bootstrap
|
|
|
|
### Architecture
|
|
|
|
_Empty — to be populated as the project grows._
|
|
|
|
### Operations & runbooks
|
|
|
|
_Empty — to be populated when we deploy._
|
|
|
|
### Security, performance, accessibility
|
|
|
|
_Empty — placeholders to be filled with rationale docs alongside their corresponding ADRs._
|