Skip to content

Add a new GH Actions job to automatically update translated document pagse #598

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 1 commit into
base: main
Choose a base branch
from

Conversation

seratch
Copy link
Member

@seratch seratch commented Apr 24, 2025

This pull request adds a new GitHub Actions job to automate the translation of document pages.

  • Before this job can run, OPENAI_API_KEY must be added to the project secrets.
  • It typically takes 8–10 minutes using the o3 model, so the job is configured to run only when there are changes under docs/ or in mkdocs.yml.
  • The job commits and pushes the translated changes, but it does not deploy the documents to GitHub Pages. If we think it’s better to deploy the latest changes automatically as well, I’m happy to update the workflow. (Personally, I don’t think it’s necessary, since the changes will be deployed with the next deployment job execution)

@seratch seratch added the documentation Improvements or additions to documentation label Apr 24, 2025
@seratch seratch requested a review from rm-openai April 24, 2025 23:37
@seratch seratch self-assigned this Apr 24, 2025
- name: Build full docs
run: make build-full-docs

- name: Commit and push changes
Copy link
Collaborator

Choose a reason for hiding this comment

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

possible to only add changes in docs? Just to prevent other stuff from slipping in?###

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