fix: daily docs scan — broken links, CI hard-fails, typos, casing#369
Closed
claude[bot] wants to merge 1 commit into
Closed
fix: daily docs scan — broken links, CI hard-fails, typos, casing#369claude[bot] wants to merge 1 commit into
claude[bot] wants to merge 1 commit into
Conversation
- Remove CI-blocked `import Video` statements left in MDX bodies across
core, react-core-linter, blog, and devlog (Video is globally registered)
- Fix broken/mismatched internal links (node msg(), next getGT(), next
DictionaryTranslationOptions prose using `d` instead of `t`)
- Add missing `occupation` frontmatter field for authors/jackie.mdx
- Add language ids to fenced code blocks missing them (blog/gt-next.mdx)
- Fix heading-hierarchy skips in core/locales.mdx (H1->H3, no established
site convention here, unlike FAQ pages)
- Fix malformed CLI parameter table missing closing pipes (cli/stage.mdx)
- Fix invalid JSON trailing comma in a code sample (with-gt-config.mdx)
- Fix duplicate list numbering and mis-indented list in devlog entries
- Fix incorrect brand/package-name casing ("GT Next" -> `gt-next`, "GT
React" -> `gt-react`, "Dev Api Keys" -> "Dev API Keys", "General
translation" -> "General Translation", "api key"/"project id" -> "API
key"/"project ID")
- Fix `Notes` sections using `-` instead of required `*` bullet marker
- Fix grammar (article "a" -> "an" before vowel sound, "d" -> "t" typo)
- Replace dead `[text](#)` placeholder links with plain bold/code text
Left untouched: FAQ pages' H3-only heading pattern (verified as a
consistent, intentional site-wide convention across 7+ faqs.mdx files,
not a defect), and issues inside Fumadocs auto-generated API stub files
(need upstream template/spec fixes, not direct edits).
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UtRNKpkDsfeQY1VAhSrXvd
Contributor
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.
Requested by Archie McKenzie · Slack thread
Daily automated documentation scan. 19 subagents (one per docs subsection, plus blog/devlog/authors) audited every
.mdxfile againstCONTRIBUTING.md/CLAUDE.mdconventions, CI hard-fail rules, and general markdown hygiene. Only high-confidence, mechanical fixes were applied — nothing here changes example code semantics or rewrites voice/style.Before / After summary
core
index.mdx: Before: a strayimport Video from '@/components/Video';in the MDX body (CI hard-fail). After: import removed —<Video>still resolves via the global MDX component registry.locales.mdx: Before: all top-level sections used###with no##present, skipping a heading level. After: promoted to##(this file's own siblings incore/all correctly start at##, so this was an isolated inconsistency, not a site convention).cli
stage.mdx: Before: a parameters table with rows missing their closing|. After: closing pipes added so the table renders correctly.key-concepts
dynamic-content.mdx: Before: an inline code example written as literal escaped backticks (\`¡Hola, $\{name\}!\`) that would render as broken text. After: proper inline code span.locadex
next.mdx: Before:gt-nextreferenced without backticks. After: wrapped in backticks per package-name convention.auto-merge.mdx: Before: image alt text with misplaced quotes ("Locadex Agent selected"). After:"Locadex Agent" selected.next (13 files)
getGTpointed at theuse-gtpage instead ofget-gt(api/components/tx.mdx,api/strings/tx.mdx).useTranslations()return value`d`when every code example in the same files uses`t`(use-translations.mdx,dictionary-translation-options.mdx).withGTProps→withGTConfig(with-gt-config.mdx), and an invalid trailing comma in ajsoncode sample in the same file.$contextrow to a parameter table, copied verbatim from the siblingInlineTranslationOptionspage (runtime-translation-options.mdx).`gt-next`(guides/languages.mdx), "Dev Api Keys" → "Dev API Keys", "General translation" → "General Translation", "gt-next" link →[`gt-next`](tutorials/examples/next-speedrun.mdx), "api key and project id" → "API key and project ID" (tutorials/examples/currency-converter/preptx.mdx).1, 2, 2→1, 2, 3) and an article typo ("aLLMs.txt" → "anLLMs.txt") inguides/migration.mdx.index.mdx.[withGTConfig()]inapi/helpers/get-locale.mdx.node
guides/strings.mdx: Before: themsg()link pointed at the same target as the adjacentgetMessages()link. After: points at its own reference page,/docs/node/api/strings/msg.react-core-linter
index.mdx,guides/quickstart.mdx: Before: strayimport Video ...statements (CI hard-fail). After: removed;<Video>still resolves globally.rules/static-string.mdx: Before: "Registration functions can only accept static strings." (wrong term, doesn't match the rest of the page). After: "Translation functions can only accept static strings."react
tutorials/mini-shop.mdx: Before: "GT React" (incorrect casing). After:`gt-react`, in both the frontmatter description and prose.api/components/gtprovider.mdx,api/strings/t-function.mdx: Before:## Notessections used-bullets. After: changed to*, per the CONTRIBUTING.md convention for API-page Notes sections.blog
i18n-without-translation-files.mdx: Before: strayimport Video ...(CI hard-fail). After: removed.gt-next.mdx: Before: a code fence with no language id (``` copy). After:```bash copy. Also fixed 3 skipped heading levels (H1→H3/H4 with no H2).devlog
gt-react_v10_15_0.mdx,gt-react_v10_19_0.mdx,react-core-linter_v0_1_0.mdx: Before: strayimport Video ...statements (CI hard-fail). After: removed.gt-i18n_v0_1_0.mdx: Before: dead placeholder links[msg()](#)etc. pointing at bare#. After: replaced with plain bold/code text.gt-next_v6_2_0.mdx: Before: a numbered list mis-indented with tabs, rendering as a code block instead of a list. After: fixed indentation so it renders as1. / 2..authors
jackie.mdx: Before: missing the requiredoccupationfrontmatter field. After: addedoccupation: Software Engineer, inferred directly from the bio text ("Jackie is a software engineer at General Translation").Flagged for human follow-up (not auto-fixed — left as-is):
docs/en-US/api/**: 6 auto-generated (Fumadocs) files are missing adescriptionin frontmatter; needs a fix in the upstream OpenAPI spec/generation step, not a direct edit.docs/en-US/python/guides/strings.mdx: amsg()link with no dedicated reference page, and a possiblecontextvs_contextparameter-name mismatch — needs an engineer to confirm intent.<Callout>blocks inpython/missing the required bold lead phrase — wording choice, left for a maintainer.authors/archie.mdx: a Twitter URL with a suspicious trailing/photosegment — not touched since altering a real person's social link needs human confirmation.authors/default.mdx: missingoccupation— no safe value to infer for the shared "Team" profile.blog/en-US/best-localization-software.mdx: two links to a docs page that doesn't appear to exist underdocs/en-US/next/— correct target is ambiguous.Deliberately left unchanged: the
###-only heading pattern (no##) used across mostfaqs.mdxpages (cli,locadex,overview,next,react,react-native,sanity) is a consistent, intentional site-wide convention, not a defect — two subagents initially "fixed" it incore/faqs.mdx,next/faqs.mdx, andreact/faqs.mdxbefore this was caught; those changes were reverted to keep all FAQ pages consistent with each other.How
Changes are confined to
.mdxcontent files acrossauthors/,blog/en-US/,devlog/en-US/, anddocs/en-US/{cli,core,key-concepts,locadex,next,node,react-core-linter,react}/. No code, config, or build files were touched.Generated by Claude Code