Skip to content

Translated Mintlify Docs into Chinese 🇨🇳, Spanish 🇪🇸, and French 🇫🇷 #1047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ErnestM1234
Copy link

@ErnestM1234 ErnestM1234 commented Aug 22, 2025

Translated Mintlify Docs into Chinese 🇨🇳, Spanish 🇪🇸, and French 🇫🇷

  • Almost all files in this PR are translated markdown files in the /zh, /fr, and /es routes.

Outside of these new translation files:

  • Added gt.config.json which determines i18n settings. For example, whether en is prefixed to the page url in the default language.
  • Added a GitHub workflow file (.github/workflows/translate.yml) which will update translations on every commit to main.
  • Edited docs.json to include localized sidebars under navigation and redirects.

Next steps

Setting up continuous translation:

  • To enable continuous translation, add your project ID and an API key as GitHub variables. You can generate these on the Dashboard.
  • Then in GitHub, navigate to Settings > Security > Secrets and Variables > Actions under Repository Secrets. Add the new environment variables as GT_PROJECT_ID and GT_API_KEY.
  • After these are added, merge the PR, and everything will be set up.
image

Troubleshooting

Failing to execute action:

  • Make sure your action is enabled: In GitHub, under organization settings, navigate to Settings > Code, planning, and automation > Actions > General > Policies, and select Allow all actions and reusable workflows or add generaltranslation/translate@* to Allow enterprise, and select non-enterprise, actions and reusable workflows. Finally, click save.

Failing to create a PR:

  • Make sure your action has permissions: In GitHub, under organization settings, navigate to Settings > Code, planning, and automation > Actions > General > Workflow permissions (at the bottom), check Allow GitHub Actions to create and approve pull requests. Finally, click save.

For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

@ErnestM1234 ErnestM1234 changed the title feat: add es, fr, and zh Translated Mintlify Docs into Chinese 🇨🇳, Spanish 🇪🇸, and French 🇫🇷 Aug 22, 2025
@ErnestM1234 ErnestM1234 marked this pull request as ready for review August 24, 2025 02:58
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