Skip to content

Fix hard-verified broken links and redirect destinations#4339

Merged
devalog merged 2 commits intomainfrom
devin/1773794853-fix-verified-broken-links
Mar 18, 2026
Merged

Fix hard-verified broken links and redirect destinations#4339
devalog merged 2 commits intomainfrom
devin/1773794853-fix-verified-broken-links

Conversation

@Swimburger
Copy link
Member

@Swimburger Swimburger commented Mar 18, 2026

Summary

Fixes 12 hard-verified broken URLs across 4 files: 6 broken internal links in MDX files and 6 redirect rules in docs.yml pointing to destinations that return 404.

How these were found: All 192 unique internal links in MDX content files and all 135 redirect destinations in docs.yml were tested against production. Only the URLs that returned 404 are fixed in this PR.

Broken internal links fixed (MDX):

File Old (404) New (200)
stainless-comparison.mdx /learn/docs/getting-started/publishing-your-docs /learn/docs/preview-publish/publishing-your-docs
stainless-comparison.mdx (×2) /learn/docs/seo/metadata /learn/docs/seo/setting-seo-metadata
markdown-basics.mdx /learn/overview/introduction (code example) /learn/sdks/overview/introduction
markdown-basics.mdx /learn/docs/building-your-docs/navigation /learn/docs/configuration/navigation
announcement-banner.mdx .../building-your-docs/announcements (code example) .../customization/announcement-banner

Broken redirect destinations fixed (docs.yml):

Source pattern Old destination (404) New destination (200)
.../nuget /learn/sdks/generators/net/publishing /learn/sdks/generators/csharp/publishing
.../customer-showcase /learn/sdks/customer-showcase /learn/sdks/overview/introduction
.../content/frontmatter /learn/docs/customization/frontmatter /learn/docs/configuration/page-level-settings
.../cli-api/* (3 rules) /learn/cli-reference/:slug* /learn/cli-api-reference/cli-reference/:slug*
.../openapi/examples .../openapi/extensions/examples .../openapi/extensions/request-response-examples
.../openrpc/.../examples .../openrpc/examples .../openrpc/extensions/request-response-examples

Review & Testing Checklist for Human

  • /learn/sdks/customer-showcase/learn/sdks/overview/introduction: The customer showcase page no longer exists. Confirm that redirecting to the SDK overview/introduction page is the best fallback (vs. the homepage or another page).
  • markdown-basics.mdx link example: One changed link is inside a <CodeBlock> used as an example of how to write relative links. Verify the new example URL (/learn/sdks/overview/introduction) still makes sense as a generic example for users.
  • Test redirects after deploy: Visit these source URLs on the preview deployment and confirm they redirect correctly:
    • /learn/sdks/guides/publish-to-package-managers/nuget → should land on csharp/publishing
    • /learn/cli-api/cli-reference/overview → should land on cli-api-reference/cli-reference/overview
    • /learn/api-definition/openapi/examples → should land on openapi/extensions/request-response-examples
    • /learn/docs/content/frontmatter → should land on configuration/page-level-settings

Notes

  • All destination URLs were verified as returning HTTP 200 on production before committing.
  • Existing redirect sources (230 non-wildcard rules) were also tested — none are broken, so no other changes were needed.
  • The building-your-docs/:slug* wildcard redirect was intentionally not changed — it chains through building-and-customizing-your-docs/:slug* which has 12 specific sub-rules for individual slugs. Instead, the two MDX files that referenced building-your-docs/ paths directly were updated to use canonical URLs.
  • The old PR Add discoverability redirects for ~130 guessable URL patterns #4337 (speculative/guessable redirects) should be closed — it was superseded by this hard-verified approach.

Link to Devin session: https://app.devin.ai/sessions/2dd15abd3d26412d9f73c60a6facb94d
Requested by: @Swimburger


Open with Devin

Broken internal links in MDX files (3):
- stainless-comparison.mdx: /learn/docs/getting-started/publishing-your-docs → /learn/docs/preview-publish/publishing-your-docs
- stainless-comparison.mdx: /learn/docs/seo/metadata → /learn/docs/seo/setting-seo-metadata (2 occurrences)
- markdown-basics.mdx: /learn/overview/introduction → /learn/sdks/overview/introduction

Broken redirect destinations in docs.yml (7):
- /learn/sdks/generators/net/publishing → /learn/sdks/generators/csharp/publishing
- /learn/sdks/customer-showcase → /learn/sdks/overview/introduction
- /learn/docs/building-and-customizing-your-docs/:slug* → /learn/docs/getting-started/:slug*
- /learn/docs/customization/frontmatter → /learn/docs/configuration/page-level-settings
- /learn/cli-reference/:slug* → /learn/cli-api-reference/cli-reference/:slug* (3 rules)
- /learn/api-definitions/openapi/extensions/examples → .../request-response-examples
- /learn/api-definitions/openrpc/examples → .../extensions/request-response-examples

All destinations verified as 200 on production.

Co-Authored-By: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>
@devin-ai-integration
Copy link
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Contributor

github-actions bot commented Mar 18, 2026

devin-ai-integration[bot]

This comment was marked as resolved.

- Revert building-your-docs wildcard redirect to preserve multi-hop chain
  through building-and-customizing-your-docs (which has 12 specific rules)
- Fix markdown-basics.mdx: /learn/docs/building-your-docs/navigation →
  /learn/docs/configuration/navigation (canonical path)
- Fix announcement-banner.mdx: building-your-docs/announcements →
  customization/announcement-banner (canonical path)

Co-Authored-By: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>
@devalog devalog merged commit efddbbc into main Mar 18, 2026
2 checks passed
@devalog devalog deleted the devin/1773794853-fix-verified-broken-links branch March 18, 2026 15:12
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