chore(docs+website): docs link cleanup and Docusaurus deprecation fix#180
Merged
Conversation
Two repeated patterns across 21 doc files (EN + ES + zh-CN mirrors): - Drop the "**Languages:**" / "**Idiomas:**" / "**语言**" line from each page. The Docusaurus site already exposes the locale via the navbar switcher, so the inline link triplet was both redundant and visually noisy when rendered. - Replace relative .md links that broke once the docs were served from Docusaurus: paths like ../../CONTRIBUTING.md (outside the docs root) become absolute GitHub URLs, and intra-docs links like ./contributors/TRANSLATION-GUIDE.md become Docusaurus route links (/docs/contributors/TRANSLATION-GUIDE) that stay stable across reorganizations. Both changes are pure rendering-quality fixes; no content shifts and no behavioral impact outside the rendered site. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Docusaurus 3.x moved the broken-Markdown-link policy from the top-level config into markdown.hooks.onBrokenMarkdownLinks. The top-level form still works but logs a deprecation warning on every boot. Same behavior, no warning. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
Two small, independent hygiene changes that were already in the working tree before the branding/favicon PR landed. Splitting them off as their own PR so they don't get buried inside an unrelated branding squash.
chore(docs):— across 21 docs (EN + ES + zh-CN mirrors): drop the redundant**Languages:**line (the Docusaurus locale switcher already exposes this in the navbar), and replace relative.mdlinks that broke when served from Docusaurus with either absolute GitHub URLs (for paths outside the docs root, like../../CONTRIBUTING.md) or Docusaurus route links (/docs/contributors/TRANSLATION-GUIDE).chore(website):— migrateonBrokenMarkdownLinksfrom the top-level config tomarkdown.hooks.onBrokenMarkdownLinksper Docusaurus 3.x. Same behavior, but suppresses the deprecation warning at boot.Commits in this PR
7022343chore(docs): clean redundant Language banners and modernize link targetsef9b174chore(website): migrate onBrokenMarkdownLinks to markdown.hooksRelationship to PR #179
Both PRs are independent and branch from
main. They can merge in either order — there is zero file overlap except forwebsite/docusaurus.config.ts, where the hunks are at different line ranges (this PR: lines 22–32; PR #179: lines 8–11 and ~149). Git resolves both cleanly.Test plan
cd website && npm run build— should no longer print theonBrokenMarkdownLinksdeprecation warning.npm run serve) and confirm: no inline**Languages:**line at the top of pages; navbar locale dropdown is the only language affordance.CONTRIBUTING.mdfromADOPTION-GUIDE,TRANSLATION-GUIDEfromintro.md) and confirm they resolve (GitHub for the former, Docusaurus route for the latter).🤖 Generated with Claude Code