docs — V32 à V34 au plan : documentation et tutoriels, en trois vagues - #49
Merged
Conversation
Une route /docs liée depuis le pied de page, à côté de « Comment ça marche », bâtie sur la séparation Diátaxis : tutoriel, guide pratique, référence, explication. L'échec habituel d'une documentation est de mélanger les quatre sur une même page — un tutoriel qui s'interrompt pour peser une alternative perd le débutant pour qui il a été écrit. Cinq règles propres à ce projet, écrites dans le plan pour qu'elles ne se perdent pas en route : 1. La doc est testée comme le code. Tout est seedé à 42, donc « vous obtiendrez 0,821 » devient une assertion e2e et une page qui dérive casse le build. Une documentation qui ne peut pas mentir, c'est la promesse du reste du site. 2. Les captures sont générées par Playwright, jamais prises à la main. 3. Mieux qu'une capture : un lien qui fait la chose, avec la démo déjà chargée. 4. Le Markdown vit dans le dépôt, coquilles prérendues, recherche locale — pas de service tiers sur un site qui publie une page /privacy. 5. La doc n'est pas PLAN.md : registre d'ingénierie en anglais d'un côté, pages utilisateur bilingues de l'autre. V32 livre la charpente et UN tutoriel complet, testé de bout en bout : il sert de gabarit à tout le reste. V33 couvre la référence des trois sections et la table des refus nommés — la page que personne d'autre n'a, parce que refuser proprement est la particularité du projet. V34 apporte les explications, les guides pratiques et la page « ce que LabML ne fait pas ». Estimation assumée : la charpente tient en une journée, la référence demande une à deux journées de rédaction pour vingt-cinq fonctionnalités en deux langues, et ça ne s'automatise pas sans produire de la bouillie. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UKw6oNC8iZ9Kn7q6x4qom4
There was a problem hiding this comment.
🟢 Approval recommended
The change is limited to roadmap/documentation planning text in PLAN.md and does not introduce code or behavioral risk.
Pull request overview
This PR updates the project roadmap in PLAN.md to define a three-wave documentation initiative (V32–V34), introducing a /docs route concept and organizing future docs work around the Diátaxis framework (tutorial / how-to / reference / explanation), including principles like testable docs and generated screenshots.
Changes:
- Adds roadmap entries for V32–V34 detailing the docs architecture, a first fully tested tutorial, a full reference, and a “table of named refusals”.
- Clarifies the intended ordering: ship one complete tutorial before writing the reference to establish a consistent template/tone.
- Records project-specific documentation rules (tested assertions, Playwright screenshots, repo-hosted Markdown, deep-links over screenshots, separation from
PLAN.md).
File summaries
| File | Description |
|---|---|
| PLAN.md | Adds V32–V34 roadmap items and updates the “Ordering” rationale for the documentation waves. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Une route
/docs, liée depuis le pied de page à côté de « Comment ça marche », bâtie sur la séparation Diátaxis : tutoriel (apprendre), guide pratique (accomplir), référence (consulter), explication (comprendre). L'échec habituel d'une documentation est de mélanger les quatre sur la même page — un tutoriel qui s'interrompt pour peser une alternative perd exactement le débutant pour qui il a été écrit.Cinq règles propres à ce projet
Écrites dans le PLAN pour qu'elles ne se perdent pas en cours de rédaction :
e2e/docs.spec.ts, et une page qui dérive casse le build. Une documentation qui ne peut pas mentir, c'est la même promesse que le reste du site./privacy.PLAN.md: registre d'ingénierie en anglais d'un côté, pages utilisateur bilingues de l'autre. Deux publics, deux fichiers.Le découpage
/docs, pipeline Markdown, sommaire, recherche) + un tutoriel complet testéLa page que personne d'autre n'a : la table des refus —
filter-not-numeric,llm-part-missing,too-large,no-webgpu, « aucun des deux n'a compris », « l'intervalle n'est pas concluant » — avec ce qui les déclenche et quoi faire. Refuser proprement est la particularité du projet ; documenter les refus est la page la plus honnête qu'il puisse publier.Estimation assumée : la charpente tient en une journée, mais documenter vingt-cinq fonctionnalités correctement en deux langues, c'est de la rédaction. Ça ne s'automatise pas sans produire de la bouillie, et trois vagues honnêtes valent mieux qu'une qui accouche de pages creuses.
Ordre : V32 livre un seul tutoriel entièrement fini, parce qu'il sert de gabarit — ton, longueur, façon de citer les chiffres. Écrire la référence avant d'avoir fixé ce gabarit, c'est se condamner à tout réécrire. C'est noté dans le paragraphe d'ordonnancement.
Documentation seule — aucun code touché.
Generated by Claude Code