Fix 31 dead links to OpenAI documentation - #3060
Conversation
platform.openai.com/docs/* now 301-redirects to developers.openai.com/api/docs/*, but pages that were restructured land on a 404 rather than their new location. 31 distinct URLs referenced in the examples are affected, appearing 40 times across 25 files. Most were deep links to a subsection that became part of the page it lived on, so dropping the stale trailing segment resolves them (docs/models/overview -> docs/models). The Assistants API tool pages are repointed at the current tool guides, and two internal cookbook.openai.com links are corrected to the slugs those notebooks are actually published under. Links are kept on platform.openai.com rather than rewritten to developers.openai.com, so the change stays limited to the broken paths. Every replacement target was verified to return HTTP 200. Only notebook cell source and markdown prose are changed. The same URLs appear 38 more times inside saved cell outputs, which are left as they are: those record what a notebook printed on a real run, and in Parse_PDF_docs_for_RAG.ipynb they are scraped page URLs that must stay consistent with the embeddings in examples/data/.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3d2ffd32dc
ℹ️ 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".
Stripping the stale trailing segment kept these two links live but lost what the link text promised: - Agent Builder now points at docs/guides/agent-builder, the dedicated page, instead of the broader docs/guides/agents. The same notebook already links that route elsewhere. - The Actions "Getting Started Example" now points at docs/actions/getting-started instead of the documentation root. Audited the other 29 replacements for the same problem: where a link text names a subsection, no dedicated page exists any more (parallel-function-calling, returning-files, timeouts, model-upgrades and annotations all 404), so the parent page remains the closest live target.
|
Both applied in a176b35 — thanks, these were real regressions in intent rather than just link rot.
Both were cases where my "drop the stale trailing segment" heuristic produced a live URL but a worse destination. Since that's a class of error rather than two isolated slips, I audited the other 29 replacements for the same thing — checking whether a more specific live page exists for each link's text. It doesn't in any remaining case: Those subsections no longer have standalone pages, so the parent page is the closest live target and readers land on the right page but may need to scroll — the limitation noted in the PR description. If you'd rather I drop the links whose text names a section that no longer exists, rather than repointing them at the parent, happy to do that instead. |
Summary
Fixes 31 dead links to OpenAI documentation, appearing 40 times across 25 files.
What's broken
platform.openai.com/docs/*now 301-redirects todevelopers.openai.com/api/docs/*, but the redirect is path-preserving. Pages that were restructured in the move land on a 404 rather than their new location:I extracted all 2167 URLs from
examples/, tested the 227 pointing atplatform.openai.comandcookbook.openai.com, and found 31 that return a hard 404. The 63 that return 403 are Cloudflare bot-blocking rather than real breakage, and are excluded.The fixes
docs/models/overview→docs/models)assistants/tools/file-search→guides/tools-file-search)cookbook.openai.comlinks, corrected to the slugs those notebooks are published under; one is agpt4v→gpt4orenameLinks are kept on
platform.openai.comrather than rewritten todevelopers.openai.com. Both hosts serve the corrected paths with a 200, so keeping the existing host limits the diff strictly to what is broken. Happy to switch to the new host if you would rather standardise on it.Deliberately not changed
The same URLs appear 38 more times inside saved cell outputs and 19 times in
examples/data/. Both are left exactly as they are:Parse_PDF_docs_for_RAG.ipynbthose output URLs are pages the notebook scraped, and they must stay consistent withexamples/data/parsed_pdf_docs.jsonandparsed_pdf_docs_with_embeddings.csv, whose embeddings are computed over that text.Only notebook cell source and markdown prose are touched.
Verification
execution_countandoutputsare byte-identical, and each cell's new source equals the URL mapping applied to its old source — 0 deviationsopenai.com; no lines inside output blocks touchednbformat.validateand parse as valid JSON.github/scripts/check_notebooks.pypassesKnown limitation
Where a link pointed at a subsection whose anchor no longer exists, it now resolves to the parent page rather than the exact section — readers land in the right place but may need to scroll. Restoring section-level precision would require anchors that the new docs site does not expose.
Only OpenAI-owned hosts were audited. The remaining ~1940 external URLs in
examples/are out of scope here and may contain further breakage.