Skip to content

docs: fix broken API reference links in zh/ja/ko translations - #4734

Closed
Tym216 wants to merge 1 commit into
openai:mainfrom
Tym216:fix/translated-docs-ref-links
Closed

docs: fix broken API reference links in zh/ja/ko translations#4734
Tym216 wants to merge 1 commit into
openai:mainfrom
Tym216:fix/translated-docs-ref-links

Conversation

@Tym216

@Tym216 Tym216 commented Aug 28, 2026

Copy link
Copy Markdown

Summary

Fix 27 broken relative links in the translated docs (docs/zh, docs/ja, docs/ko).

The API reference pages live under docs/ref/ (English only). From a page under docs/{zh,ja,ko}/, the current ref/... links resolve to a non-existent docs/{zh,ja,ko}/ref/ path, which 404s on the published site (for example, docs/zh/testing.mdref/testing.md resolves to /zh/ref/testing.md).

This PR adds the missing ../ prefix so the links resolve to the shared English reference pages (../ref/...).

Test plan

  • Verified all 9 link targets exist under docs/ref/ (e.g. ref/testing.md, ref/mcp/manager.md, ref/extensions/experimental/codex/*.md)
  • Confirmed no remaining ](ref/ links under docs/zh, docs/ja, docs/ko
  • English docs are unchanged
  • Docs-only change (no code changes)

Issue number

N/A

Checks

  • I've added new tests, if relevant
  • I've run .agents/skills/code-change-verification/scripts/run.sh (skipped: docs-only change)
  • I've confirmed all verification steps pass
  • If using Codex, I've run /review before submitting this PR

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: dc000a469a

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread docs/ja/agents.md
```

コールバックの全機能については、[Lifecycle API リファレンス](ref/lifecycle.md)を参照してください。
コールバックの全機能については、[Lifecycle API リファレンス](../ref/lifecycle.md)を参照してください。

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Make the link correction in the translation generator

When any corresponding English page is retranslated, translate_docs.py recreates this generated file from the English source, whose URL remains ref/lifecycle.md, and the translation prompt explicitly preserves link URLs; this will therefore overwrite the added prefix and reintroduce the broken link. Implement the relative-link adjustment in the translation pipeline and regenerate the localized pages rather than editing generated translations directly.

AGENTS.md reference: AGENTS.md:L178-L179

Useful? React with 👍 / 👎.

@seratch

seratch commented Aug 28, 2026

Copy link
Copy Markdown
Member

This could only happen with preview on github.com; the live document site doesn't have the issue at all.

@seratch seratch closed this Aug 28, 2026
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.

2 participants