julien/apf_portal

Fork 0

Files

T

History

Julien Gautier 43c54616d8

CI / commits (pull_request) Successful in 3m53s

Details

CI / scan (pull_request) Successful in 4m0s

Details

CI / check (pull_request) Successful in 4m16s

Details

CI / a11y (pull_request) Successful in 3m25s

Details

Docs site / build (pull_request) Successful in 3m31s

Details

CI / perf (pull_request) Successful in 6m51s

Details

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

80-dotfiles.sh was reading notes/aliases.zsh and notes/gitconfig.txt,
but notes/ is gitignored - fresh clones on the dev VM hit "file not
found" and the script aborted.

Move both templates to docs/setup/dotfiles/ where they ship with every
clone. gitconfig.txt's [user] block now carries placeholder identity
(your name / your.email@example.com) instead of the original author's
identity - the script overlays the prompted values at install time so
the file content doesn't matter functionally, but the placeholders
read more clearly as "fill me in".

80-dotfiles.sh source paths flipped from $REPO_ROOT/notes/... to
$REPO_ROOT/docs/setup/dotfiles/.... Step-3 table row, §8.4 (dotfiles
repo appendix), and the setup README index updated accordingly. New
"dotfiles/" section in the setup README documents the folder.

The notes/aliases.zsh and notes/gitconfig.txt on existing dev
workstations are unaffected - those files live outside the repo and
this PR doesn't touch them.

2026-05-24 21:22:08 +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(adr): accept ADR-0026 + ADR-0027 (#219 )

2026-05-24 16:58:39 +02:00

setup

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

2026-05-24 21:22:08 +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.