apf_portal/docs/index.md at e0e090f024df52b2b4c66e54b29ab9afcec854ec

julien/apf_portal

Fork 0

Files

T

Julien Gautier e0e090f024

CI / scan (pull_request) Failing after 2m27s

Details

CI / commits (pull_request) Successful in 2m38s

Details

CI / a11y (pull_request) Successful in 1m45s

Details

CI / check (pull_request) Successful in 4m27s

Details

Docs site / build (pull_request) Successful in 2m2s

Details

CI / perf (pull_request) Successful in 4m24s

Details

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

Implementation of ADR-0022.

* `vitepress`, `vitepress-plugin-mermaid` and `mermaid` added to
  workspace devDependencies. Build settled at ~9 s for the full
  site, sub-second incremental in dev.
* `docs/.vitepress/config.mts`:
  * `srcExclude` drops `docs/README.md` (git/IDE-only index) and
    `docs/decisions/template.md` (authoring scaffold).
  * `rewrites` maps `decisions/README.md` → `decisions/index.md`
    so `/decisions/` resolves to the curated landing while the
    source stays git-friendly.
  * `ignoreDeadLinks` skips cross-repo refs (`../CLAUDE`,
    `../../apps/**`, `../../notes/**`), `localhost:*` dev URLs,
    and the deliberately-excluded `README`/`template` references —
    the source stays usable from a git/IDE reader without
    breaking the site build.
  * Auto-generated sub-sidebar for `/decisions` walks
    `00NN-*.md` so adding an ADR is one file.
  * Mermaid via `withMermaid` with `securityLevel: 'strict'`.
* `docs/index.md` — VitePress Hero landing with four feature
  cards (Architecture, Decisions, Development, Onboarding).
* `package.json` exposes `docs:dev`, `docs:build`, `docs:preview`.
* `docs/development.md` (line ~5): `[setup/](setup/)` → first
  page, since folder-style links don't resolve cleanly under
  `cleanUrls`. Line 330: wrap `${{ github.* }}` in
  `<code v-pre>…</code>` so VitePress's Vue template parser
  doesn't trip on the curly-brace interpolation.
* `.gitea/workflows/docs-site.yml` — builds on every PR (gate
  on parse errors + genuine dead links), uploads the dist as an
  artifact on push to main. The Mermaid plugin regression fence
  greps for `class="mermaid"` / `<svg>` in ADR-0009's rendered
  HTML.
* `.gitignore` excludes `docs/.vitepress/{cache,dist}/`.

Deployment target stays provisional per ADR-0022; the workflow
publishes a `docs-site` artifact for now. The rsync step lands
once the future infrastructure ADR locks the host.

2026-05-15 19:08:04 +02:00

1.3 KiB

Raw Blame History

layout, hero, features

layout

hero

features

home

name

text

tagline

actions

APF Portal

Documentation

Architecture decisions, development guide, and onboarding material for APF France Handicap's web portal.

theme	text	link
brand	Read the architecture	/architecture

theme	text	link
alt	Browse decisions	/decisions/

title	details	link	linkText
Architecture	System context, container diagram, Nx module boundaries, CI/CD pipeline. Cross-cutting Mermaid diagrams that frame the whole platform.	/architecture	Open architecture

title	details	link	linkText
Decisions (ADRs)	Every non-trivial choice — auth flow, sessions, audit trail, downstream-API access, accessibility, performance budgets, admin app — recorded as MADR 4.0.0 ADRs.	/decisions/	Open decisions

title	details	link	linkText
Development guide	Repo layout, daily commands, observability dev-loop (Jaeger, log↔trace correlation), dependency updates, conventional commits.	/development	Open development guide

title	details	link	linkText
Onboarding	WSL terminal setup, Node + pnpm + Docker, Angular + Nx monorepo bootstrap. Everything a new contributor needs to get a working environment.	/setup/01-wsl-terminal-setup	Start onboarding

1.3 KiB Raw Blame History

1.3 KiB

Raw Blame History