Skip to content

docs: la documentation Typst complète du projet, et l'hébergement permanent (#217) - #218

Merged
DireDoch merged 1 commit into
developfrom
docs/217-documentation-typst
Aug 19, 2026
Merged

DireDoch merged 1 commit into
developfrom
docs/217-documentation-typst

Conversation

@DireDoch

Copy link
Copy Markdown
Owner

Premier lot de la documentation Typst (#217), à mi-parcours pour revue.

Ce qui est livré

Docs/documentation.typ → Docs/documentation.pdf (26 pages) :

  • le thème, la page de garde brandée, la table des matières, les en-têtes/pieds ;
  • les sections 1 à 5 rédigées ;
  • les sections 6 à 8 en squelette — leurs titres fixent le plan et résolvent les renvois croisés, leur corps arrive au lot suivant ;
  • 4 des 11 diagrammes structurels (trois axes d’une Race, machine d’état, pipeline d’assets, chaîne d’intégration) plus le handshake d’identité en séquence ;
  • les 18 placeholders de capture avec leur légende rédigée ;
  • les 12 PNG de design/out/ embarqués.
typst compile --root . Docs/documentation.typ Docs/documentation.pdf

--root . est exigé : le document importe design/composants.typ et design/out/, hors du dossier Docs/.

Écarts avec l’énoncé de l’issue, tranchés en faveur du code

L’issue dit Le code dit
25 messages WebSocket (16 + 9) 29 — 20 ClientEvent + 9 ServerEvent (ws/protocol.rs)
4 sorties de Race 5 — finished/abandoned/failed/burned/outpaced (core/race-state.ts:35)
~21 500 lignes TS, ~7 900 Rust 11 368 TS (+2 312 CSS, +1 878 JSON) · 7 960 Rust

design/composants.typ

Une ligne : logo() ciblait la seule famille « JetBrainsMono NF » et retombait sur la sérif par défaut là où elle n’est pas installée — le wordmark cessait d’être en chasse fixe, c’est-à-dire cessait d’être celui du jeu. Passé en pile de repli, celle que --font-mono nomme déjà dans style.css. Les PNG committés sont inchangés si la régénération se fait sur une machine qui a la NF.

À trancher

Les polices Fira Sans, JetBrainsMono NF, Noto Sans, Hack ne sont pas installées sur la machine de dev. Le document prend Segoe UI + Consolas — les replis que style.css nomme lui-même. Les vraies Inter/JetBrains Mono sont dans frontend/public/fonts mais en .woff2, format que Typst ne charge pas ; les convertir en .ttf et les committer donnerait les polices exactes du jeu.

Hors de ce lot

Sections 6 à 8, les 6 diagrammes restants, la suppression de Docs/onboarding.*, le renvoi depuis le README, et le commentaire d’issue listant les captures à prendre.

L’issue #217 reste ouverte : elle porte needs-design-approval, seul le développeur la ferme après validation visuelle.

Premier lot de `Docs/documentation.typ` : le thème, la page de garde, la table
des matières, et les sections 1 à 5 rédigées. Les sections 6 à 8 sont posées en
squelette — leurs titres fixent le plan et résolvent les renvois croisés des
sections précédentes, leur corps arrive au lot suivant.

Le thème importe sa palette de `design/composants.typ` et n'écrit aucun hex :
une retouche de `frontend/src/style.css` remonte jusqu'au PDF. Corps inversé
pour l'impression, `corail` réservé aux filets et aux étiquettes.

Contient 4 des 11 diagrammes (trois axes d'une Race, machine d'état, pipeline
d'assets, chaîne d'intégration — plus le handshake d'identité en séquence), les
18 placeholders de capture avec leur légende, et les 12 PNG de `design/out/`
embarqués.

Trois écarts avec l'énoncé de l'issue, tranchés en faveur du code : le protocole
porte 29 messages et non 25 (20 ClientEvent + 9 ServerEvent), une Race a cinq
états terminaux et non quatre (`race-state.ts`), et les décomptes de lignes de
l'issue étaient surestimés.

La compilation exige `--root .` : le document importe hors de `Docs/`.

`logo()` de `design/composants.typ` ciblait la seule famille « JetBrainsMono NF »
et retombait sur la sérif par défaut là où elle n'est pas installée — le wordmark
cessait alors d'être en chasse fixe. Passé en pile de repli, celle que
`--font-mono` nomme déjà dans le CSS.

`Docs/onboarding.*` n'est pas encore supprimé et le README pas encore modifié :
c'est le lot final.
@DireDoch DireDoch changed the title docs: la documentation Typst du projet, sections 1 à 5 (#217) docs: la documentation Typst complète du projet, et l'hébergement permanent (#217) Aug 19, 2026
@DireDoch
DireDoch merged commit 87284b4 into develop Aug 19, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant