Repository navigation
docs: bring back the open roadmap items and the French pages the English rewrite replaced - #26
Merged
Merged
Conversation
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.
The English rewrite in #25 replaced Lin's French
docs/docs.mdwithdocs/project/decisions.mdanddocs/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: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 indocs/to the crate socargo test --doccompiles 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.docs/README.md: no "reviewed" checkboxes, sources cited by file and symbol or test name, the symbol counts when a line number disagrees.Cargo.tomlandCargo.lockkept 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 bydocs/internals/architecture.md.French pages
Under
docs/i18n/fr/, mirroring the repo root, the same layout as Project-Colony/Eidos:docs/i18n/fr/README.mddocs/i18n/fr/docs/README.mddocs/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.shandscripts/i18n-links.pyare copied from Eidos, with the stamp renamed toxion-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 newtranslations up to dateCI job runs both, withactions/checkoutpinned by full SHA like the other jobs. Both pass locally;docs/internals/architecture.mdlists the new job.The job is not a required check yet; adding it to branch protection is a separate setting.