Skip to content

Daily docs scan: fix CI-blocking imports, broken code examples, and typos#344

Closed
claude[bot] wants to merge 1 commit into
mainfrom
docs/daily-scan-2026-07-06
Closed

Daily docs scan: fix CI-blocking imports, broken code examples, and typos#344
claude[bot] wants to merge 1 commit into
mainfrom
docs/daily-scan-2026-07-06

Conversation

@claude

@claude claude Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Requested by Archie McKenzie · Slack thread

Summary

Daily automated docs scan. Fixed high-confidence documentation issues found across docs/en-US/, blog/en-US/, devlog/en-US/, and authors/.

CI-blocking fixes

  • core, react-core-linter (2 files), blog, devlog (3 files) — Removed a redundant import Video from '@/components/Video'; statement from 7 files. Raw import/export statements in MDX bodies are a CI hard-fail per CONTRIBUTING.md, and <Video> is already available as a global MDX component (confirmed by docs/en-US/locadex/mintlify.mdx, which uses <Video> with no import).

Broken/inconsistent code examples (docs/en-US/next)

  • api/dictionary/get-translations.mdx — Before: example function used await without being declared async (a syntax error if copied). After: added async.
  • api/config/with-gt-config.mdx — Before: example gt.config.json had a trailing comma (invalid JSON); prop referenced as _batchInterval but documented elsewhere as batchInterval. After: fixed both.
  • api/middleware/create-next-middleware.mdx — Before: the "Remove default locale prefix" example set prefixDefaultLocale: true, contradicting the surrounding prose. After: set to false.
  • api/dictionary/use-translations.mdx — Before: code comment said // Hello, Alice but the dictionary defines "Hello, Bob". After: comment corrected.
  • guides/dictionaries.mdx — Before: server-component example calls getTranslations() into d, but the JSX referenced an undefined t. After: uses d.
  • api/strings/tx.mdx, api/components/tx.mdx — Before: getGT links pointed at the useGT page; a garbled run-on sentence. After: fixed link targets and sentence.
  • api/config/load-dictionary.mdx, api/config/load-translations.mdx — Before: table header said "Type" over a column of parameter names. After: relabeled "Parameter".
  • api/types/runtime-translation-options.mdx — Before: $context was documented as a parameter but missing from the description table. After: added its row.
  • guides/migration.mdx — Before: numbered list had two items labeled "2." After: renumbered to 1/2/3.
  • guides/local-tx.mdx — Before: dangling "API References:" bullet with no links (every sibling guide lists its related API pages). After: added the two relevant API links.
  • api/components/t.mdx, api/components/tx.mdx — Before: heading "### Descriptions" (repo convention is singular "Description"). After: fixed.
  • api/types/dictionary-translation-options.mdx — Before: "Next steps" used ### while every other page uses ##. After: fixed heading level.

docs/en-US/core

  • class/methods/translation/setup-project.mdx — Before: example read jobStatus.jobs[0].status, but checkJobStatus returns a flat array per its own reference page. After: jobStatus[0].status.
  • class/methods/formatting/format-date-time.mdx — Removed a leftover empty ## Next steps heading with no content underneath (the same links already exist under ## Related methods).

docs/en-US/python

  • api/t-fallback.mdx — Before: example imported from a non-existent gt_i18n package. After: gt_flask/gt_fastapi, matching the sibling t.mdx reference page.
  • guides/strings.mdx — Before: examples used context=/$context, but the actual GT option (per api/t.mdx) is _context. After: fixed all five occurrences.

docs/en-US/sanity

  • guides/configuration.mdx — Before: said singleton translation IDs are randomly generated by default; the plugin's own API reference says the default is ${docId}-${locale}. After: reconciled the two.

Prose, capitalization, and formatting

  • docs/en-US/react-native, docs/en-US/react — fixed "Render settings controls" → "control" (subject-verb agreement) in both gtprovider.mdx files; cleaned up inconsistent list-marker style in react-native/relativetime.mdx.
  • docs/en-US/cli/reference/config.mdx — fixed a missing verb ("if you want to your Spanish translations" → "...to save your Spanish translations").
  • docs/en-US/locadex — fixed a misplaced quote in image alt text (auto-merge.mdx) and "App router" → "App Router" capitalization (mintlify.mdx).
  • docs/en-US/overview — "Clickhouse" → "ClickHouse"; "Yes you can!" → "Yes, you can!".
  • docs/en-US/key-concepts/dynamic-content.mdx — fixed escaped backticks breaking inline code rendering, "any contents" → "any content", "ie," → "i.e.,", "nor" → "or".
  • docs/en-US/react-core-linter/rules/static-string.mdx — "Registration functions" → "Translation functions" (matches the page's own topic).
  • devlog/en-US/gt-next_v6_10_0.mdx — fixed a comma splice and a duplicated "the reading the".
  • authors/ — added the required occupation frontmatter field to default.mdx and jackie.mdx; fixed a malformed Twitter URL (stray /photo suffix) in archie.mdx.
  • blog/en-US/ — added language ids to 6 bare fenced code blocks across gt-next.mdx, plurals.mdx, and multilingual-nextjs-seo.mdx.

How

Touched 48 .mdx files across docs/en-US/{core,next,react,react-native,cli,python,sanity,react-core-linter,locadex,overview,key-concepts}, blog/en-US/, devlog/en-US/, and authors/. No docs-templates/ files were touched. Verified with the repo's own scripts/validate-links.ts (all links valid) after applying changes.

Found via 18 parallel documentation-scan agents (one per docs subsection) auditing against CONTRIBUTING.md conventions; every fix listed above was independently verified against the actual repo content before being applied — nothing here is a guess.

…ypos

Removes redundant `import Video` statements (a CI hard-fail per
CONTRIBUTING.md) from 7 files where <Video> is already available as a
global MDX component. Fixes several broken/inconsistent code examples
across the Next.js docs (wrong return-type access, missing async,
trailing comma in JSON, mismatched prop names, contradictory config
example, undefined variable reference, wrong link targets). Also fixes
missing frontmatter fields, prose typos, capitalization, and bare code
fences across docs, blog, devlog, and author profiles.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KsNx9nooJaQocCPYCHsZEg
@claude
claude Bot requested a review from a team as a code owner July 6, 2026 15:25
@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