docs: fix malformed external URLs missing platform subdomain - #2880
Merged
Conversation
The IA v3 URL migration stripped "platform" from external hostnames as well as internal paths, turning platform.openai.com into .openai.com and platform.claude.com into .claude.com. Those are invalid hostnames, so the links fail at DNS resolution rather than returning an HTTP error, and the build's broken-link check only covers internal links. Restore the subdomain on all 21 occurrences across 9 files. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
marcel-rbro
added
documentation
Contributor
|
🗑️ Preview for this PR was deleted. |
marcel-rbro
marked this pull request as ready for review
August 17, 2026 13:02
TC-MO
approved these changes
Aug 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this fixes
The IA v3 URL migration stripped
platformfrom external hostnames as well as internal paths, corrupting 21 links across 9 files:These are hard-dead rather than redirects -
.openai.comis not a valid hostname, so they fail at DNS resolution instead of returning an HTTP status. The build's broken-link check only validates internal links, so CI stayed green and nothing surfaced them.Most sit in prerequisites sections, where a reader following the link to get an API key hits a browser error.
Approach
This is a pure inverse of the corruption - restore the subdomain, change nothing else - so it stays trivially reviewable.
sources/platform/integrations/ai/openai/openai-assistants.mdsources/platform/integrations/ai/openai/chatgpt.mdsources/platform/integrations/ai/langflow.mdsources/platform/integrations/ai/mastra.mdsources/platform/integrations/ai/agno.mdsources/platform/integrations/ai/crewai.mdsources/platform/integrations/ai/haystack.mdsources/platform/integrations/ai/langgraph.mdsources/platform/integrations/ai/openai/openai-agents.mdlangchain.mdcarried a 22nd occurrence, already fixed by #2683.Verification
git grep -n "https://\.\w" -- 'sources/**/*.md' 'sources/**/*.mdx'returns nothing.platform.platform.double-prefixes.403tocurl(/account/api-keys,/docs/api-reference/vector-stores) - that is OpenAI blocking non-browser clients, not a dead page.Deliberately out of scope
Two things worth separate follow-up rather than mixing into a link fix:
/docs/...links now301todevelopers.openai.com/api/docs/.... Correct after this fix, but one redirect hop from canonical./docs/assistants/overviewredirects to/docs/assistants/migration- OpenAI is deprecating the Assistants API. That is a content problem foropenai-assistants.md(7 of the 21 links live on that page), not a link problem.Suggested guard
Nothing in CI checks external links today, which is why a mechanical find/replace could break 22 of them silently. Worth considering an external-link check, at minimum a hostname sanity check for
https://.