julien/apf_portal

Fork 0

Files

T

History

Julien Gautier 774f279785

CI / scan (pull_request) Successful in 3m24s

Details

CI / commits (pull_request) Successful in 3m44s

Details

CI / check (pull_request) Successful in 3m53s

Details

CI / a11y (pull_request) Successful in 4m7s

Details

Docs site / build (pull_request) Successful in 4m18s

Details

CI / perf (pull_request) Successful in 8m36s

Details

docs(decisions): add ADR-0030 dockerised full-stack dev mode (proposed)

Propose an 'apps' Compose profile backed by a shared Dockerfile.dev so
developers can 'docker compose up' all three Nx apps (portal-bff,
portal-shell, portal-admin) with no native Node/pnpm — addressing
onboarding friction (the nvm/.zshrc class of failure) and a concrete
request to run the whole stack in one command.

Decision-only, proposed status. Profile-gated so the native +
devcontainer flows are unchanged; dev-only (production images stay
with the ADR-0028 Container Registry follow-up). Takes number 0030
(0029 is reserved for the cascade/Pleiades/Acteurs+ syncs ADR).

2026-05-29 17:37:21 +02:00

.vitepress

fix(docs): cap vite below 7 (rolldown-vite) and pin mermaid transitives (#161 )

2026-05-15 23:57:57 +02:00

decisions

docs(decisions): add ADR-0030 dockerised full-stack dev mode (proposed)

2026-05-29 17:37:21 +02:00

setup

docs(setup): version aliases.zsh + gitconfig.txt under docs/setup/dotfiles (#224 )

2026-05-24 21:23:24 +02:00

architecture.md

fix(portal-bff): align admin entra role name with Portal.Admin (#145 )

2026-05-15 10:33:54 +02:00

development.md

docs(development): refresh after phase-3a + add topology / trace diagrams (#160 )

2026-05-15 23:08:50 +02:00

index.md

feat(docs): vitepress site for docs/, mermaid rendering, ci build workflow (#154 )

2026-05-15 19:14:14 +02:00

README.md

docs(development): add observability dev-loop section (#73 )

2026-05-10 02:14:46 +02:00

README.md

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.