docs: fix dead links in documentation - #7085
Open
Indian-boult wants to merge 1 commit into
Open
Conversation
- LoCoMo benchmark repo moved orgs: snap-stanford -> snap-research - TypeScript migration guide link pointed at a page that does not exist (migration/ts-v2-to-v3); point at migration/oss-v2-to-v3, which contains the TS OSS and Client SDK sections - OpenAI structured-outputs guide URL dropped the /introduction suffix upstream (3 files) - AgentOps dashboard deep-link app.agentops.ai/dashboard/api-keys no longer resolves unauthenticated; use app.agentops.ai - api-reference add-memories Tip linked to a #body-messages anchor that does not exist in the page; point at #common-fields
|
Hi @Indian-boult, thanks for opening this pull request. This is just a soft check: you are not yet in this repo's vouched contributor list ( A maintainer can vouch for you by commenting |
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
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.
Linked Issue
N/A — documentation-only change (exempt from the accepted-issue gate per CONTRIBUTING.md).
Description
Fixes 7 dead links found by sweeping all 247
.mdxpages underdocs/and HTTP-verifying every URL:docs/core-concepts/memory-evaluation.mdxsnap-stanford/locomoreturns 404snap-research/locomo(verified 200)docs/changelog/sdk.mdxmigration/ts-v2-to-v3, a page that does not exist indocs/migration/migration/oss-v2-to-v3, which contains the TypeScript OSS and Client SDK sectionsdocs/components/llms/overview.mdx/introductionpath segment was removed upstream.../guides/structured-outputs(verified 200)docs/components/llms/models/openai.mdxdocs/components/llms/models/azure_openai.mdxdocs/integrations/agentops.mdxapp.agentops.ai/dashboard/api-keysreturns 404; AgentOps docs now reference only the dashboard roothttps://app.agentops.ai(verified 200)docs/api-reference/memory/add-memories.mdx#body-messagesanchor that does not exist on the page#common-fields, the heading the parameter table actually lives underType of Change
AI Assistance
Agent used: an LLM coding agent swept the docs for dead links and drafted the diff. What I verified myself before opening this PR:
Every replacement URL was fetched live and returns HTTP 200 (the AgentOps and LoCoMo replacements were cross-checked against the target sites' current pages).
The
#common-fieldsheading exists inadd-memories.mdx; the old#body-messagesanchor matches no heading in that file.python scripts/check-llms-txt-coverage.pypasses on this branch.I can explain every line of this diff and how it interacts with the rest of the codebase, without asking an AI tool.
Each change is a single href swap; no code paths are touched.
Breaking Changes
N/A
Test Coverage
Manual verification: re-ran a link sweep across
docs/**/*.mdxafter the changes — all previously-dead URLs now resolve.check-llms-txt-coverage.pyexits 0 (no.mdxpages added or removed).Checklist