docs: fix stale and broken vercel.com links#2910
Conversation
Audited every vercel.com link in docs/content (20 unique URLs, HTTP-validated including anchor fragments): - project-configuration#regions (2x): the #regions anchor no longer exists on that page — content moved to the vercel-json subpage; now links project-configuration/vercel-json#regions - gateway/api-reference/overview (2x): hard 404; the AI Gateway docs restructured — 'get an API key' context now points at ai-gateway/authentication - observability/otel-overview (1x): redirects to tracing/instrumentation; link the final URL - docs/workflow and docs/workflow/python (8x): redirect to the plural docs/workflows paths; link the final URLs (also drops a redundant ?language=py param that the redirect discards) All other links (queues, queues/pricing + anchors, plans/hobby, limits, regions, sandbox, workflows/pricing#storage-retention, cli/project-linking, audit-log, home, help, blog) verified 200 with live anchors.
|
There was a problem hiding this comment.
Pull request overview
This PR audits and fixes stale/broken vercel.com documentation links within docs/content (v4 and v5), updating redirects/404s and correcting anchor targets so readers land on the intended Vercel docs sections.
Changes:
- Update OpenTelemetry docs link for
@vercel/otelto Vercel’s current tracing documentation. - Replace deprecated
/docs/workflowand related Python docs URLs with the current/docs/workflowsroutes (and remove a redundant?language=py). - Fix broken/relocated Vercel docs pages/anchors (AI Gateway page move;
vercel.json#regionsanchor target).
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/content/docs/v5/observability/tracing.mdx | Updates @vercel/otel link to the current tracing instrumentation page. |
| docs/content/docs/v5/getting-started/python.mdx | Updates Workflow Python documentation links to /docs/workflows/python. |
| docs/content/docs/v5/deploying/world/vercel-world.mdx | Updates Workflow docs links and fixes vercel.json regions anchor target. |
| docs/content/docs/v5/ai/index.mdx | Updates AI Gateway doc link to the new authentication page. |
| docs/content/docs/v4/getting-started/python.mdx | Mirrors v5 Python docs link fixes for v4 docs. |
| docs/content/docs/v4/deploying/world/vercel-world.mdx | Updates Workflow docs links to the current /docs/workflows route. |
| docs/content/docs/v4/ai/index.mdx | Mirrors v5 AI Gateway link fix for v4 docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Audited every vercel.com link in docs/content (20 unique URLs, HTTP-validated including anchor fragments): - project-configuration#regions (2x): the #regions anchor no longer exists on that page — content moved to the vercel-json subpage; now links project-configuration/vercel-json#regions - gateway/api-reference/overview (2x): hard 404; the AI Gateway docs restructured — 'get an API key' context now points at ai-gateway/authentication - observability/otel-overview (1x): redirects to tracing/instrumentation; link the final URL - docs/workflow and docs/workflow/python (8x): redirect to the plural docs/workflows paths; link the final URLs (also drops a redundant ?language=py param that the redirect discards) All other links (queues, queues/pricing + anchors, plans/hobby, limits, regions, sandbox, workflows/pricing#storage-retention, cli/project-linking, audit-log, home, help, blog) verified 200 with live anchors. Signed-off-by: Nathan Rajlich <n@n8.io>
|
Backport PR opened against |
Audited every vercel.com link in docs/content (20 unique URLs, HTTP-validated including anchor fragments): - project-configuration#regions (2x): the #regions anchor no longer exists on that page — content moved to the vercel-json subpage; now links project-configuration/vercel-json#regions - gateway/api-reference/overview (2x): hard 404; the AI Gateway docs restructured — 'get an API key' context now points at ai-gateway/authentication - observability/otel-overview (1x): redirects to tracing/instrumentation; link the final URL - docs/workflow and docs/workflow/python (8x): redirect to the plural docs/workflows paths; link the final URLs (also drops a redundant ?language=py param that the redirect discards) All other links (queues, queues/pricing + anchors, plans/hobby, limits, regions, sandbox, workflows/pricing#storage-retention, cli/project-linking, audit-log, home, help, blog) verified 200 with live anchors. Signed-off-by: Nathan Rajlich <n@n8.io> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
What
Full audit of every
vercel.comlink indocs/content(20 unique URLs, validated by HTTP status and anchor-fragment presence in page content):#regionsno longer exists on/docs/project-configuration(content split into subpages)/docs/project-configuration/vercel-json#regions(anchor verified live)/docs/gateway/api-reference/overview(AI Gateway docs restructured)/docs/ai-gateway/authentication(the "get an API key" context)/docs/observability/otel-overview/docs/tracing/instrumentation(the redirect target)/docs/workflow+/docs/workflow/python(singular → plural rename)/docs/workflows//docs/workflows/python(also drops a redundant?language=pythe redirect discards)All remaining links verified 200 with live anchors (queues +
#consumer-function-security,workflows/pricing#storage-retention, plans/hobby, limits, regions, sandbox, cli/project-linking, audit-log, home, help, blog).Prompted by a report that the
vercel.jsonregions link in the new multi-region docs pointed at the wrong page.