Skip to content

Add i18n support to the documents #460

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

Merged
merged 1 commit into from
Apr 8, 2025
Merged

Add i18n support to the documents #460

merged 1 commit into from
Apr 8, 2025

Conversation

seratch
Copy link
Member

@seratch seratch commented Apr 8, 2025

This pull request adds i18n support to the documentation website. As the first language to be supported, the generator script currently supports only Japanese. However, if we add more languages here, we can use the same mechanism for any other non-English languages.

The script processes the English document files under docs/ and generates equivalent ones in language-specific directories, such as docs/ja. You can run the script with make build-full-docs; note that an OPENAI_API_KEY is required.

A few things to be noted:

  • Added i18n plugin to mkdocs data pipeline
  • The nav bar settings are now duplicated for en and ja; skipped API references for ja because of some technical issues for now
  • Although the non-English content generation is very slow, using 4.5 model is MUST for the output quality
  • Whenever we update English pages or add new pages, we need to run the generate-full-docs command
  • No impact to deployment process
  • new warning messages on stdout I could not resolve quickly, but there is no issue with the output

@seratch seratch added the documentation Improvements or additions to documentation label Apr 8, 2025
@rm-openai rm-openai marked this pull request as ready for review April 8, 2025 13:41
@rm-openai rm-openai merged commit ece647b into openai:main Apr 8, 2025
5 checks passed
rm-openai pushed a commit that referenced this pull request Apr 10, 2025
This pull request improves the translation pipeline, which was
introduced by #460. Now the document generation works pretty well with
gpt-4o model.
Lightblues pushed a commit to Lightblues/openai-agents-python that referenced this pull request Apr 13, 2025
Lightblues pushed a commit to Lightblues/openai-agents-python that referenced this pull request Apr 13, 2025
This pull request improves the translation pipeline, which was
introduced by openai#460. Now the document generation works pretty well with
gpt-4o model.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants