Skip to content

Integrate ai-translate-action for automated README translations - #15

Merged
chenwei791129 merged 3 commits into
mainfrom
copilot/integrate-ai-translate-action
Jan 29, 2026
Merged

Integrate ai-translate-action for automated README translations#15
chenwei791129 merged 3 commits into
mainfrom
copilot/integrate-ai-translate-action

Conversation

Copilot AI commented Jan 18, 2026

Copy link
Copy Markdown
Contributor

Automates translation of README.md into Traditional Chinese, Simplified Chinese, and Japanese using GitHub's native AI translation action. Eliminates manual translation maintenance.

Changes

Workflow automation

  • Added .github/workflows/translate.yml triggered on README.md changes to main
  • Matrix strategy translates 3 languages in parallel
  • Custom instructions preserve code blocks, technical terms, and markdown formatting
  • Auto-generates PR with updated translations

Repository structure

  • Created /docs/readme/ for all translated files
  • Moved README.zh-TW.mddocs/readme/README.zh-TW.md
  • Added placeholder files for README.zh-CN.md and README.ja.md

Navigation links

  • Updated all README files with consistent language navigation
  • Root links use docs/readme/ paths
  • Translation files use relative paths (../../README.md for English, same-directory for translations)

Workflow permissions

Requires contents: write, pull-requests: write, and models: read for GitHub's AI model access. No external API keys needed.

Original prompt

This section details on the original issue you should resolve

<issue_title>Proposal: Integrate ai-translate-action to automate README translations</issue_title>
<issue_description>### Description
To make this project more accessible to a global audience, I propose integrating the ai-translate-action into our GitHub Actions workflow. This will automatically translate the README.md file into multiple languages whenever changes are pushed to the main branch.

Proposed Changes

  1. Workflow Automation: Create a new GitHub Action workflow file (e.g., .github/workflows/translate.yml).
  2. Multilingual Support: Initially target the following languages:
    • Traditional Chinese (zh-TW)
    • Simplified Chinese (zh-CN)
    • Japanese (ja)
    • (Add or remove languages as needed)
  3. Output Management: The action will generate translated versions of the README (e.g., README.zh-TW.md) and keep them in sync with the English source.

Benefits

  • Wider Reach: Improves SEO and accessibility for non-English speaking developers.
  • Reduced Maintenance: Eliminates the need for manual translations or PRs for documentation updates.
  • AI-Powered Accuracy: Utilizes LLMs to ensure the context of the technical documentation is preserved better than standard machine translation.

Implementation Checklist

  • Create a sub folder /docs/readme/ to save all translated readme files
  • Configure the translate.yml workflow with ai-translate-action.
  • Test the workflow to ensure formatting remains intact.
  • Update the main README.md with links to the translated versions.

Action URL: https://github.com/FidelusAleksander/ai-translate-action</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Add ai-translate-action for README translations Integrate ai-translate-action for automated README translations Jan 18, 2026
Copilot AI requested a review from chenwei791129 January 18, 2026 14:06
@chenwei791129
chenwei791129 marked this pull request as ready for review January 26, 2026 17:57
@chenwei791129
chenwei791129 merged commit bab3fe9 into main Jan 29, 2026
1 check passed
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.

Proposal: Integrate ai-translate-action to automate README translations

2 participants