Restructure localization docs, document XLIFF extract/compose workflow - #340
Merged
Conversation
✅ Documentation buildRevision built successfully Build logsWarnings (2) |
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.
Problem
The Localization page (
tools/docs/translate.md) mixed an overview, the Yandex Translate provider reference and file filtering into one article. Theextractandcomposesubcommands were barely mentioned: a single intro sentence plus an orphan table with one option. The page also contained two dangling anchors -#catand#json-schemaspointed to sections that do not exist.Changes
The section is now a hub with three child articles (both locales, ru + en):
translate.md, URL preserved) - overview of the three translation methods, how the translation pipeline works (segmentation, markup protection), what gets translated (md + yaml/json via schemas, closes the dangling#json-schemasanchor), common parameters, list-file filtering andno-translatecontent markers.translate-yandex.md, new) - the default Yandex Translate provider: auth token types, folder, glossary, limits andTRANSLATE_LIMIT_EXCEED.translate-ai.md) - untouched except cross-links updated to the new structure.translate-xliff.md, new) - the extract/compose round trip: xliff + skl pair mechanics, full cycle example, XLIFF 1.2 format with inline<g>/<x/>tags, and full parameter reference for both subcommands (--filter,--schema,--no-ref-resolve,--use-source).All parameter descriptions verified against @diplodoc/cli v5.55 sources. Existing anchors (
#auto,#file-filter,#content-filter) are kept on the hub page, and the previously broken dash characters in theno-translateexamples are fixed.Both locales build cleanly with
yfm buildv5.57 (no new lint warnings).