Skip to content

Add configuration files for Localization Agentic Workflows#685

Open
zdrawku wants to merge 2 commits into2.0from
zkolev/agentic-workflow-for-localization
Open

Add configuration files for Localization Agentic Workflows#685
zdrawku wants to merge 2 commits into2.0from
zkolev/agentic-workflow-for-localization

Conversation

@zdrawku
Copy link
Copy Markdown

@zdrawku zdrawku commented May 8, 2026

This PR sets up an AI-powered agentic workflow to automatically translate the documentation from English to Japanese. Here's what it does:

What it introduces

An automated EN → JP localization pipeline using GitHub Agentic Workflows (gh-aw) powered by GitHub Copilot (Claude Sonnet).

How it works

  • Triggers on every push to master that touches .md/.mdx files under docs/** or versioned_docs/**, plus a manual workflow_dispatch with an optional full_resync flag.
  • Detects changed files, translates them into Japanese, and maps them to the correct output path under i18n/ja/docusaurus-plugin-content-docs/.
  • Opens a PR automatically with the translated files, labeled [i18n, ja, automated].

Files added (8 total)

File Purpose
.github/workflows/translate-docs-ja.md Human-readable workflow definition (the agent "prompt")
.github/workflows/translate-docs-ja.lock.yml Compiled workflow YAML (~1,400 lines) — auto-generated, do not edit
.github/agents/agentic-workflows.agent.md Dispatcher agent config for Copilot to route to the right agentic workflow prompts
.github/aw/actions-lock.json Pinned SHA locks for all GitHub Actions used
.github/mcp.json MCP server config to expose gh aw mcp-server
.github/workflows/copilot-setup-steps.yml Installs the gh-aw CLI extension for Copilot Agent
.gitattributes Marks .lock.yml files as generated (linguist + merge strategy)
.vscode/settings.json Enables Copilot for markdown files in VS Code

Key guardrails

  • Skips files with translate: false in front-matter
  • Preserves code blocks, anchors, front-matter IDs, and MDX tags — only prose is translated
  • Never touches i18n/ja/code.json or theme strings
  • Idempotent — re-running on the same commit produces no diff
  • Concurrency control prevents race conditions on rapid pushes

@zdrawku zdrawku linked an issue May 8, 2026 that may be closed by this pull request
@zdrawku zdrawku requested a review from brianlagunas May 8, 2026 15:21
Copy link
Copy Markdown
Member

@brianlagunas brianlagunas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at a high level this looks good. The only comment I really have is around translation strings. I don't have the answer to this just yet, but something to consider is that when new topic is added, we should be generating translation strings by calling either npm run write-translations for English, and npm run write-translations:ja for Japanaese. When the string are written, then they can be translated. Perhaps this is a separate agent / PR that occurs after the topics are added?

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.

Feature Request: Introduce Agentic Workflow for Localization

2 participants