Skip to content

TD-21: Translate the TechDocs content - #355

Draft
brianzelip wants to merge 6 commits into
mainfrom
TD-21-enable-i18n
Draft

brianzelip wants to merge 6 commits into
mainfrom
TD-21-enable-i18n

Conversation

@brianzelip

@brianzelip brianzelip commented Jul 31, 2026 •

Copy link
Copy Markdown
Collaborator

What we need on our computers to carry out this work

  1. git + text editor
  2. Some AI tool that has the capability and permission to access your local file system and write to files.

What the output looks like from this workflow

The intended workflow for this project is to translate one file at a time from English into another language.

The output from this workflow is one translated file. Run the workflow X times to translate X different files.

Commit message should include

  • authorship notes re: LLM used

The actual steps we need to take

  1. Update via find-and-replace all instances of the 3 placeholders in TD-21-i18n-PROMPT.md
    a. {TARGET_LANGUAGE}, ie: SPANISH
    b. {LOCALE_CODE}, ie: es (NOTE the lowercase!)
    c. {RELATIVE_FILE_NAME}, ie: administration/backup.md
  2. Provide the updated prompt to a LLM agent, ie:

See the prompt at @TD-21-i18n-PROMPT.md and follow up with the tasks described there.

  1. Review the output, check
    a. the "shape" looks the same (frontmatter keys, headings, etc.)
    b. things that should not be translated are not translated (file name, shell commands, etc.)

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 31, 2026 •

Copy link
Copy Markdown

Deploying archivesspace-tech-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3277e18
Status: ✅  Deploy successful!
Preview URL: https://ff37a79b.archivesspace-tech-docs.pages.dev
Branch Preview URL: https://td-21-enable-i18n.archivesspace-tech-docs.pages.dev

View logs

@crugas crugas mentioned this pull request Oct 30, 2026
@brianzelip
brianzelip changed the base branch from main to TD-22-enable-i18n November 16, 2026 15:02
@brianzelip
brianzelip changed the base branch from TD-22-enable-i18n to main November 16, 2026 15:06
Add guardrails to the translation prompt, project doc, and glossary
based on committee feedback from the Dutch translation PR:

- The agent communicates with collaborators only in English; the
  target language appears only in the translated page and that
  language's glossary column. Translator notes are written in English.
- Each run edits only the target language's section of the glossary.
- A run changes only the translated page, the glossary, and that
  language's notes log; collaborators check this before committing.

Also add src/content/docs/{nl,fr,de,ja,es,uk}/.gitkeep so each
language's content directory exists in the repo before any
translations are added, and update the project doc to match.

This branch has not been deployed

No deployments
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