agentleFS
Sign inStart free
OxyFlaxOxyFlax/AI/skills/translate-docs/SKILL.md

translate-docs

Skill0 starsChanged 5 months agoMITView on GitHub

Translate documentation (.md files) into another language. Use when: translating a markdown doc, updating an existing translation after source changes, localizing documentation, creating a french translation of a doc, keeping translations in sync with the source. Default target language is French. Translated files are placed in a folder named after the language (e.g. 'french/') mirroring the source path.

8 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

7 rules. 0 are common, 5 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 8 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If the output file does not exist: proceed to Step 3 (full translation).

    line 38
  2. Distinctive:

    If the output file exists: proceed to Step 4 (incremental update).

    line 39
  3. Very specific:

    Read the entire source .md file.

    line 43
  4. Distinctive:

    Create the output file at the computed path (create parent directories if needed).

    line 51
  5. Very specific:

    Read both the source .md and the existing translation.

    line 55
  6. Distinctive:

    Use structural landmarks (headings, table rows) to align the two documents.

    line 57
  7. Distinctive:

    After writing the output file, verify:

    line 64

“Common” is measured: kept by at least 6 in 10 of the 8 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

translate-docs

Translates .md documentation files into a target language and places them in a language-named folder that mirrors the source path structure.

When to Use

  • Translating a new .md doc into French (or another language)
  • Updating a translation when the source .md has changed
  • Checking whether an existing translation is up to date

Conventions

ConceptConvention
Target language folderNamed after the language in lowercase English (e.g. french/, spanish/, german/)
Output pathInsert the language folder under the source folder path (e.g. docs/foo.md → docs/french/foo.md)
File nameSame as the source file name
Default languageFrench (use when no language is specified)

Procedure

Step 1 — Identify source and output paths

  1. Note the source .md path (e.g. docs/acquisition-node-comparison.md).
  2. Determine the target language (default: french).
  3. Compute the output path: insert the language folder inside the source file’s parent folder.
    • Example: docs/foo.md → docs/french/foo.md
    • Example: readme.md → french/readme.md (root files place french in workspace root)

Step 2 — Check for an existing translation

  • If the output file does not exist: proceed to Step 3 (full translation).
  • If the output file exists: proceed to Step 4 (incremental update).

Step 3 — Full translation (new file)

  1. Read the entire source .md file.
  2. Translate all prose content into the target language.
  3. Preserve exactly:
    • Markdown structure (headings, lists, tables, code blocks, links, images)
    • Code snippets and inline code (do not translate code)
    • Technical terms, product names, API names, and proper nouns
    • Front-matter YAML/TOML (translate values only if they are human-readable descriptions)
    • Link URLs (translate only visible link text if appropriate)
  4. Create the output file at the computed path (create parent directories if needed).

Step 4 — Incremental update (existing translation)

  1. Read both the source .md and the existing translation.
  2. Identify sections or paragraphs that differ between the current source and what the translation reflects.
    • Use structural landmarks (headings, table rows) to align the two documents.
  3. Translate only the changed or added content.
  4. Preserve already-correct translated sections unchanged.
  5. Overwrite the translation file with the updated content.

Step 5 — Quality check

After writing the output file, verify:

  • All headings are translated.
  • No source-language sentences remain (except inside code blocks).
  • Code blocks are untouched.
  • Table structure is intact.
  • Internal links still resolve (adjust relative paths if the folder depth changed).
  • File saved at the correct output path.

Examples

User promptSourceOutput
"Translate docs/foo.md"docs/foo.mddocs/french/foo.md
"Translate readme.md to spanish"readme.mdfrench/readme.md
"Update the french translation of docs/bar.md"docs/bar.mddocs/french/bar.md (updated)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free