Skip to content

docs: fix CI hard-fails and doc quality issues (daily scan 2026-07-08)#347

Closed
claude[bot] wants to merge 2 commits into
mainfrom
docs/daily-scan-2026-07-08
Closed

docs: fix CI hard-fails and doc quality issues (daily scan 2026-07-08)#347
claude[bot] wants to merge 2 commits into
mainfrom
docs/daily-scan-2026-07-08

Conversation

@claude

@claude claude Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Requested by Archie McKenzie · Slack thread

Daily automated documentation quality scan. Fixes high-confidence issues found across docs/, blog/, and devlog/ — CI-breaking import statements, 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 stray import Video from '@/components/Video' — the <Video> component is globally provided (other pages use it with no import) and this bare import violates 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 from h3 to h2 — same heading-hierarchy issue as the overview/sanity FAQ pages below.

next

  • api/components/tx.mdx, api/strings/tx.mdx: getGT links pointed at the useGT reference page instead of get-gt — fixed to point at the correct page.
  • api/middleware/create-next-middleware.mdx: the "Remove default locale prefix" example set prefixDefaultLocale: true, which does the opposite of what the surrounding prose describes — corrected to false. Also removed a trailing empty "Next steps" heading with no content.
  • api/types/dictionary-translation-options.mdx: "Next steps" heading was an h3 instead of h2, 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 called gt(...) 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: the msg() reference linked to the unrelated t() API page (no msg() reference page exists) — unlinked to plain text. Also fixed four context= kwargs that should be _context= per the actual t() 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 stray import Video statement 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 from h3 to h2 — the page had no h2 at 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 from h3 to h2, matching the heading pattern used by every other page in this subsection.

blog

  • i18n-without-translation-files.mdx: removed a stray import Video statement (same issue as above).
  • gt-next.mdx: added a language id to a bare code fence (```copy```bash copy), and promoted a heading from h3 to h2 (first heading in the doc, skipping h2).
  • multilingual-nextjs-seo.mdx, plurals.mdx: added text language 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 stray import Video statement.
  • 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: added text language 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 .mdx files touched across docs/en-US/, blog/en-US/, devlog/en-US/, and authors/. No content restructuring, voice/style rewrites, or docs-templates/ changes — only mechanical corrections listed above. Verified locally: pnpm build:content builds cleanly, scripts/validate-links.ts passes with no broken links, and the CI hard-fail grep checks (banned tags, javascript: URLs) pass.

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/.
@claude
claude Bot requested a review from a team as a code owner July 8, 2026 15:18
Same heading-hierarchy fix already applied to the overview and sanity FAQ pages.
@moss-bryophyta

Copy link
Copy Markdown
Contributor

Closing stale docs PR — docs review is moving to a linter-based workflow going forward, and this backlog is now out of date (per Taylor). Keeping #372 and #373.

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