Skip to content

Docs: fix the four confirmed documentation/contract drifts #231

Description

@Reefact

Problem

Four places where following the documentation produces wrong results, each verified against the tree:

  1. DeterministicTesting.en.md and .fr.md (~line 163) still claim Clock.UseAny()/InstanceIds.UseAny() "take an optional seed" — both are parameterless since the ADR-0026 rebase; reproducibility flows through Dummies.Any.Reproducibly(...). The only stale API sentence in the whole doc set, and ADR-0026's one missed follow-up.
  2. CONTRIBUTING.fr.md:260-266 lists 5 commit scopes where the English (and the enforcing linter) has 7 — the binder and dummies rows are missing.
  3. 20 of 25 French user guides footer-link to the dead anchor README.fr.md#-étapes-suivantes (the heading no longer exists; correct target: #-documentation) — the FR mirror of EN fix 7cf826a that was never applied.
  4. CONTRIBUTING.md:269-274 states the commit scope "carries no versioning weight, only readability" and names "the two published packages" — but the train tooling (tools/trains.sh, release-notes.sh, collect-prs.sh) now assigns commits to trains by scope and silently drops unscoped commits from release notes and changelogs. A contributor following CONTRIBUTING to the letter can make a user-facing change invisible to the release record. The stale future-tense "Adoption" paragraph (483-487) predates the hook/CI check.

Impact

1 and 3 break users directly; 2 and 4 misstate an enforced contract — 4 can silently erase user-facing changes from the release record on real releases.

Direction

Apply the four fixes (EN+FR in lockstep per CLAUDE.md); for 4, document the train mapping and the unscoped-commit consequence (or point to AddingAReleaseTrain.en.md).

Acceptance criteria

  • The four cited passages match the shipped API, the linter's scope list, the real anchors, and the release tooling's actual semantics.
  • FR and EN are in lockstep for every touched file.

Context

Surfaced by the 2026-07-20 architecture, design & ecosystem audit (doc/handwritten/for-maintainers/audit/2026-07-20-firstclasserrors-architecture-and-design-audit.md, §11.4/§11.5/§14-C4; branch claude/firstclasserrors-audit-83gap7).

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions