Skip to content

docs(moteur): renvoyer à la doc du moteur au lieu de la recopier (dsoxlab#201) - #32

Merged
stephrobert merged 3 commits into
mainfrom
docs/moteur-par-lien
Nov 14, 2026
Merged

stephrobert merged 3 commits into
mainfrom
docs/moteur-par-lien

Conversation

@stephrobert

Copy link
Copy Markdown
Owner

Aligne le catalogue sur le squelette corrigé de dsoxlab new catalog (dsoxlab main 2663b6b, issue stephrobert/dsoxlab#201) : la doc du moteur n'est plus recopiée, elle est liée.

Remplacé par un lien

  • README.md / README.fr.md, « How it works / Comment ça marche » : les sous-sections « The declarative contract (two levels) / Le contrat déclaratif, à deux niveaux » et « The lab lifecycle / Le cycle de vie d'un lab » laissent la place à « The engine, documented where it lives / Le moteur, documenté là où il vit », texte exact de README_EN / README_FR dans src/dsoxlab/services/scaffold_socle.py. Liens vers docs/contract-v1, docs/commands, docs/learner et docs/catalog-author de dsoxlab (pages vérifiées présentes).
  • CHANGELOG.md / CHANGELOG.fr.md : entrée « Unreleased / Non publié ».

Corrigé

Rien : l'inventaire ne relève aucun passage faux dans ce catalogue, et son CONTRIBUTING ne porte pas le paragraphe list-labs du gabarit.

Ce qui reste propre au catalogue

Les prérequis, l'installation, le premier lab, « Runtimes », le modèle de validation, « Scoring, hints, progress » (gardé, comme dans le squelette actuel), le catalogue (scripts/gen_catalog.py --check : à jour). CONTRIBUTING est inchangé : son « Anatomy of a lab » porte surtout des choses propres au dépôt (solution posée sur challenge/work, hints.source.yaml, mutants du dernier lab).

Corrigé dans un second commit

  • CONTRIBUTING.md « Anatomy of a lab » (et la version française) disait « lab.fr.yaml French override of title/description ONLY ». Le moteur a tranché (dsoxlab#374) : lab.<lang>.yaml surcharge aussi les libellés de criteria, et docs/contract-v1.md le dit désormais. La ligne l'indique, comme dans les autres catalogues.

Mesure

validate-structure --json du moteur de main (2663b6b), joué depuis le clone :

  • avant : stale_doc = 0, toutes les familles à 0 ;
  • après : stale_doc = 0, toutes les familles à 0, sortie 0.

pytest tests/ : 112 passés, 14 ignorés. Hooks pre-commit joués et verts au commit.

🤖 Generated with Claude Code

stephrobert and others added 3 commits November 14, 2026 12:59
…xlab#201)

Le README recopiait le contrat déclaratif et le cycle de vie d'un lab, qui
décrivent dsoxlab et dérivent à chaque version du moteur. Ces sous-sections
laissent la place au texte du squelette de `dsoxlab new catalog` : des liens
vers contract-v1, commands, learner et catalog-author. Ce qui est propre au
catalogue reste.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Le contrat de dsoxlab le dit désormais (dsoxlab#374) : un lab.<langue>.yaml
surcharge title, description et le label de chaque critère.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@stephrobert
stephrobert merged commit 6201578 into main Nov 14, 2026
8 checks passed
@stephrobert
stephrobert deleted the docs/moteur-par-lien branch November 14, 2026 13:58
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