docs: fix CI hard-fails and doc quality issues (daily scan 2026-07-08)#347
Closed
claude[bot] wants to merge 2 commits into
Closed
docs: fix CI hard-fails and doc quality issues (daily scan 2026-07-08)#347claude[bot] wants to merge 2 commits into
claude[bot] wants to merge 2 commits into
Conversation
Removes stray import statements that violate the MDX import ban, fixes broken/self-inconsistent links, heading-level hierarchy, missing code fence language ids, and a handful of prose/API-signature inaccuracies found during a daily docs quality scan across docs/, blog/, and devlog/.
Same heading-hierarchy fix already applied to the overview and sanity FAQ pages.
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 quality scan. Fixes high-confidence issues found across
docs/,blog/, anddevlog/— CI-breakingimportstatements, broken/self-contradicting links, heading hierarchy, missing code-fence language ids, and a few factual inaccuracies in code examples.Before / After
core
index.mdx: removed a strayimport Video from '@/components/Video'— the<Video>component is globally provided (other pages use it with no import) and this bareimportviolates the MDX import ban.quickstart.mdx: a stray####heading inside a<Callout>was splitting a sentence into a heading + orphan paragraph — removed the heading markup so it reads as one sentence.react-native
faqs.mdx: promoted all FAQ headings fromh3toh2— same heading-hierarchy issue as the overview/sanity FAQ pages below.next
api/components/tx.mdx,api/strings/tx.mdx:getGTlinks pointed at theuseGTreference page instead ofget-gt— fixed to point at the correct page.api/middleware/create-next-middleware.mdx: the "Remove default locale prefix" example setprefixDefaultLocale: true, which does the opposite of what the surrounding prose describes — corrected tofalse. Also removed a trailing empty "Next steps" heading with no content.api/types/dictionary-translation-options.mdx: "Next steps" heading was anh3instead ofh2, breaking the section hierarchy — fixed.guides/migration.mdx: a numbered list had two items labeled "2." — renumbered the second to "3."guides/local-tx.mdx: removed a dangling "API References:" bullet with no sub-items.tutorials/examples/currency-converter/setup.mdx: removed an empty "Conclusion" heading with no body text.tutorials/translating-strings.mdx: an example calledgt(...)with a nested{ variables: { key: value } }object, but the documented (and every other example's) call signature passes variables as top-level keys — fixed the example and the accompanying note.cli
generate.mdx: fixed a grammatical error ("for your project for your default locale") in the command description.python
guides/strings.mdx: themsg()reference linked to the unrelatedt()API page (nomsg()reference page exists) — unlinked to plain text. Also fixed fourcontext=kwargs that should be_context=per the actualt()API reference.locadex
auto-merge.mdx: fixed ambiguous alt text where a quotation mark made it look like the whole phrase was quoted instead of just the dropdown value.next.mdx: removed a leftover commented-out image reference in the published prose.react-core-linter
index.mdx,guides/quickstart.mdx: removed the same strayimport Videostatement described above.rules/static-string.mdx: "Registration functions can only accept static strings" corrected to "Translation functions" (the doc is about translation functions, not registration).overview
faqs.mdx: promoted all FAQ headings fromh3toh2— the page had noh2at all, so every question skipped a heading level.index.mdx: fixed "Clickhouse" → "ClickHouse" (correct brand capitalization).key-concepts
dynamic-content.mdx: fixed a malformed inline code sample that had unnecessary backslash-escapes (rendered as literal backslashes instead of formatted code), and "ie" → "i.e." for consistency with the rest of the file.sanity
faqs.mdx: promoted all FAQ headings fromh3toh2, matching the heading pattern used by every other page in this subsection.blog
i18n-without-translation-files.mdx: removed a strayimport Videostatement (same issue as above).gt-next.mdx: added a language id to a bare code fence (```copy→```bash copy), and promoted a heading fromh3toh2(first heading in the doc, skippingh2).multilingual-nextjs-seo.mdx,plurals.mdx: addedtextlanguage ids to six bare code fences.devlog
gt-react_v10_15_0.mdx,gt-react_v10_19_0.mdx,react-core-linter_v0_1_0.mdx: removed the same strayimport Videostatement.gt-i18n_v0_1_0.mdx: unlinked three placeholder links ([msg()](#), etc.) that pointed at dead#anchors instead of real pages.gt-next_v6_3_0.mdx,gt-react_v10_18_0.mdx: addedtextlanguage ids to two bare code fences.authors
archie.mdx: fixed a Twitter/X profile URL that pointed at the photo-viewer sub-path instead of the profile itself.How
33
.mdxfiles touched acrossdocs/en-US/,blog/en-US/,devlog/en-US/, andauthors/. No content restructuring, voice/style rewrites, ordocs-templates/changes — only mechanical corrections listed above. Verified locally:pnpm build:contentbuilds cleanly,scripts/validate-links.tspasses with no broken links, and the CI hard-fail grep checks (banned tags,javascript:URLs) pass.