Skip to content

Fix broken links (Devin)#5987

Merged
devalog merged 2 commits into
mainfrom
devin/fix-broken-links
Jun 27, 2026
Merged

Fix broken links (Devin)#5987
devalog merged 2 commits into
mainfrom
devin/fix-broken-links

Conversation

@github-actions

@github-actions github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes broken links detected by the scheduled link checker.

Source-fixable links:

  1. customize-api-refcustomize-api-reference-layout: The page slug for "Customize your API Reference layout" auto-derives as customize-api-reference-layout, not customize-api-ref. Fixed in api-explorer.mdx (2 occurrences).

  2. /learn/docs/content/components//learn/docs/writing-content/components/: The "Components" section lives under "Writing content" in docs.yml, so the URL path uses writing-content not content. Fixed across 6 files (en + zh): visual-editor.mdx, sdk-snippets.mdx, markdown-basics.mdx, changelogs.mdx.

  3. zh Microsoft docs URL with trailing : The bare URL in the zh changelog was picking up the Chinese full stop as part of the link. Wrapped in angle brackets to make the URL boundary explicit.

Non-source links (zh locale): Remaining broken links are auto-generated zh changelog/asset URLs with no corresponding source file references. These are documented in a PR comment for manual validation.

Link to Devin session: https://app.devin.ai/sessions/297d6eeb30574061898bb034a90583bc

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Remaining broken links — need manual validation

The following broken links are not referenced in any source file — they appear to be auto-generated URLs (zh locale changelogs, assets, and OpenRPC pages). These cannot be fixed by editing source files and likely require investigation at the platform/build level.

zh changelog 404s (missing translation files)

These zh changelog dates don't have corresponding translation files in fern/translations/zh/:

  • /learn/zh/cli-api-reference/cli-reference/changelog/2026/6/25
  • /learn/zh/docs/self-hosted/release-notes/2026/6/24
  • /learn/zh/sdks/generators/csharp/changelog/2026/6/25
  • /learn/zh/sdks/generators/go/changelog/2026/6/24
  • /learn/zh/sdks/generators/java/changelog/2026/6/24 and 2026/6/25
  • /learn/zh/sdks/generators/ruby/changelog/2026/6/25
  • /learn/zh/sdks/generators/rust/changelog/2026/6/24 and 2026/6/25
  • /learn/zh/sdks/generators/typescript/changelog/2026/6/24

zh changelog 500s (older dates, server error)

These return 500 errors — English equivalents exist but zh translations may be missing or misconfigured:

  • /learn/zh/cli-api-reference/cli-reference/changelog/2023/3/7, 2024/11/1, 2025/2/18, 2025/5/22
  • /learn/zh/sdks/generators/go/changelog/2025/5/13
  • /learn/zh/sdks/generators/java/changelog/2024/5/8
  • /learn/zh/sdks/generators/php/changelog/2025/11/27
  • /learn/zh/sdks/generators/python/changelog/2025/8/4
  • /learn/zh/sdks/generators/typescript/changelog/2025/10/14, 2025/9/30

zh asset 404

  • /learn/zh/dashboard/assets/api-keys.mp4 — No zh assets directory exists. The English version references api-keys-demo.mp4 (different filename).

zh OpenRPC 500

  • /learn/zh/api-definitions/openrpc/extensions/server-names.md — URL has .md extension appended which is incorrect. The correct page slug is server-names (no extension). This URL isn't referenced in any source file.

| [Callouts](/learn/docs/content/components/callouts) | Supported |
| [Accordions](/learn/docs/writing-content/components/accordions) | Supported |
| [Accordion Groups](/learn/docs/writing-content/components/accordion-groups) | Supported |
| [Aside](/learn/docs/writing-content/components/aside) | Coming soon |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'soon' that become outdated

| [Icons](/learn/docs/content/components/icons) | Coming soon |
| [Parameter Fields](/learn/docs/content/components/parameter-fields) | Supported |
| [Steps](/learn/docs/content/components/steps) | Supported |
| [Frames](/learn/docs/writing-content/components/frames) | Coming soon |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'soon' that become outdated

| [Parameter Fields](/learn/docs/content/components/parameter-fields) | Supported |
| [Steps](/learn/docs/content/components/steps) | Supported |
| [Frames](/learn/docs/writing-content/components/frames) | Coming soon |
| [Icons](/learn/docs/writing-content/components/icons) | Coming soon |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'soon' that become outdated

| [Tabs](/learn/docs/content/components/tabs) | Supported |
| [Tooltips](/learn/docs/content/components/tooltips) | Coming soon |
| [Tabs](/learn/docs/writing-content/components/tabs) | Supported |
| [Tooltips](/learn/docs/writing-content/components/tooltips) | Coming soon |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'soon' that become outdated

@github-actions

github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor Author

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Verified fixes using the preview link (fern-preview-devin-fix-broken-links.docs.buildwithfern.com). All updated links return 200:

  • /learn/docs/api-references/customize-api-reference-layout#setting-api-explorer-options
  • /learn/docs/writing-content/components/callouts
  • /learn/docs/writing-content/components/accordions
  • /learn/docs/writing-content/components/overview
  • /learn/docs/writing-content/components/request-snippet
  • /learn/docs/writing-content/components/response-snippet

The vale warnings about "Coming soon" are pre-existing text — only the URL paths were changed in this PR.

@devin-ai-integration devin-ai-integration Bot marked this pull request as ready for review June 26, 2026 12:04
@devin-ai-integration devin-ai-integration Bot requested a review from devalog as a code owner June 26, 2026 12:04
@devin-ai-integration devin-ai-integration Bot force-pushed the devin/fix-broken-links branch from a118da2 to 6f6ca6e Compare June 26, 2026 17:01
@devalog devalog merged commit 470b688 into main Jun 27, 2026
4 checks passed
@devalog devalog deleted the devin/fix-broken-links branch June 27, 2026 11:14
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.

1 participant