Skip to content

Conversation

seratch
Copy link
Member

@seratch seratch commented Sep 3, 2025

Summary

  • expand the translation instructions used by the documentation script with additional formatting guardrails
  • add table handling guidance and more explicit self-review steps to the translation workflow prompt
  • update code-block placeholders to use three-digit identifiers for consistency

Testing

  • make lint
  • make mypy (fails: missing optional dependencies such as numpy, litellm, sqlalchemy)
  • make tests (fails: missing optional dependencies such as numpy, litellm)

My prompt:

Can you improve the translation script to align with this reference: https://raw.githubusercontent.com/openai/openai-agents-js/refs/heads/main/docs/src/scripts/translate.ts? The approach to handling files is a bit different in the TS repo, so please just take the useful parts from the instructions to help improve the overall quality.

https://chatgpt.com/codex/tasks/task_i_68b7f2f102808320aafcecaef3e393eb

@seratch seratch added documentation Improvements or additions to documentation project labels Sep 3, 2025
@@ -208,7 +234,7 @@ def translate_file(file_path: str, target_path: str, lang_code: str) -> None:
code_block_chunks.append(line)
if in_code_block is True:
code_blocks.append("\n".join(code_block_chunks))
current_chunk.append(f"CODE_BLOCK_{(len(code_blocks) - 1):02}")
current_chunk.append(f"CODE_BLOCK_{(len(code_blocks) - 1):03}")
Copy link
Member Author

Choose a reason for hiding this comment

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

this is optional, but it's good

@seratch seratch merged commit 244ce39 into main Sep 3, 2025
5 checks passed
@seratch seratch deleted the codex/improve-translation-script-for-quality branch September 3, 2025 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codex documentation Improvements or additions to documentation project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant