Back to Tuist

Tuist Docs Markdown Translation Context

server/priv/docs/L10N.md

4.194.02.6 KB
Original Source

Tuist Docs Markdown Translation Context

These sources are Tuist documentation pages rendered by the Phoenix docs pipeline. The Markdown is not generic Markdown: it can include JSON frontmatter, explicit heading anchors, GitHub-style alerts, code groups, Phoenix components, and Tuist-specific link components.

Renderer-sensitive syntax

  • Keep frontmatter delimiters (---) and keys intact. The current source pages use JSON inside the frontmatter block, and the translated page must still parse as a map.
  • Translate human-readable frontmatter values such as title and description. Preserve placeholders such as :title and the product name "Tuist".
  • Preserve explicit heading anchors like {#install-tuist} exactly. They are stable URL fragments.
  • Preserve fenced code blocks exactly, including commands, comments, indentation, fence languages, and code-group labels.
  • Preserve inline code spans exactly.
  • Preserve GitHub alert markers like > [!NOTE], > [!TIP], and > [!WARNING]. Translate only the alert title and prose.
  • Preserve <.localized_link> and <LocalizedLink> tags, their href or to attributes, and their closing tags. Translate the visible link text only.
  • Preserve component names and structure for tags such as <HomeCards> and <HomeCard>.
  • In component attributes, preserve path-like attributes such as href, to, src, link, icon, width, and height. Translate visible prose attributes such as title, details, linkText, and image alt text when appropriate.
  • Preserve markdown table structure, list markers, blockquotes, and HTML tags.

Product terminology

  • Keep "Tuist", "Mise", "Homebrew", "Xcode", "Swift", "Gradle", "CLI", "CI", "Linux", "macOS", "HTTP", and "proxy" untranslated unless the target language commonly uses the same technical term with localized casing.
  • Keep command names such as tuist, mise use, mise install, brew install, and curl unchanged.
  • "Generated projects", "module cache", "Xcode cache", and "Gradle cache" can be translated as concepts, but do not translate command names, URLs, or path segments that contain those words.

Pilot scope

This L10N.md intentionally translates only a small set of docs pages while we learn which Markdown scenarios need stronger instructions or validators.

Validation loop

The translation workflow writes each candidate to the target path and runs validation_command. If validation fails, the error is sent back to the model for another candidate, up to validation_attempts total attempts. The command can read L10N_SOURCE_PATH, L10N_OUTPUT_PATH, L10N_LOCALE, L10N_LANGUAGE, and L10N_FORMAT from the environment.