Skip to content

docs: bring back the open roadmap items and the French pages the English rewrite replaced - #26

Merged
MotherSphere merged 2 commits into
mainfrom
docs/restore-xion-fr
Oct 14, 2026
Merged

MotherSphere merged 2 commits into
mainfrom
docs/restore-xion-fr

Conversation

@MotherSphere

Copy link
Copy Markdown
Member

The English rewrite in #25 replaced Lin's French docs/docs.md with docs/project/decisions.md and docs/README.md. Lin wanted two things kept from it: the open items of its documentation roadmap, and the French pages themselves. This restores both.

Brought back into the English docs

Compared against git show f6239dd^:docs/docs.md:

  • Open roadmap items, as a "Documentation still to write" section in docs/project/decisions.md, each marked open: interaction diagrams (modules and data flow), the iced render cycle and state model in detail, and tying the code examples in docs/ to the crate so cargo test --doc compiles them. A fourth open item asks for each page to carry the date it was last checked against the code, which the old file required and no page does today.
  • How the docs stay honest (the old "Sur la relecture des documents"), as a "How these pages stay true" section in docs/README.md: no "reviewed" checkboxes, sources cited by file and symbol or test name, the symbol counts when a line number disagrees.
  • Two dropped rules: Rust edition 2024 with Cargo.toml and Cargo.lock kept current, and full keyboard and mouse use.

Not brought back: the "gaps from the ecosystem convention" section, since #25 fixed all of them (English docs, docs/ sorted by reader, README on the template). The completed roadmap items and the quality section are already covered by docs/internals/architecture.md.

French pages

Under docs/i18n/fr/, mirroring the repo root, the same layout as Project-Colony/Eidos:

  • docs/i18n/fr/README.md
  • docs/i18n/fr/docs/README.md
  • docs/i18n/fr/docs/project/decisions.md, reusing Lin's original wording wherever it still matches the current English.

Each starts with <!-- xion-i18n: source=<path> sha=<git hash-object of the source> -->. The README gets a short "## Language" section linking them. English stays canonical.

Checks

scripts/i18n-check.sh and scripts/i18n-links.py are copied from Eidos, with the stamp renamed to xion-i18n. The first fails when an English source changes after its translation was stamped, or when a translation's headings, code fences or table rows no longer match the source; the second fails on any Markdown link or anchor that leads nowhere. A new translations up to date CI job runs both, with actions/checkout pinned by full SHA like the other jobs. Both pass locally; docs/internals/architecture.md lists the new job.

The job is not a required check yet; adding it to branch protection is a separate setting.

@MotherSphere
MotherSphere merged commit 8a03721 into main Oct 14, 2026
7 checks passed
@MotherSphere
MotherSphere deleted the docs/restore-xion-fr branch October 14, 2026 23:59
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