Skip to content

docs: daily content-quality fixes (2026-07-02)#337

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

docs: daily content-quality fixes (2026-07-02)#337
claude[bot] wants to merge 1 commit into
mainfrom
docs/daily-scan-2026-07-02

Conversation

@claude

@claude claude Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Requested by Archie McKenzie · Slack thread

Summary

Daily automated documentation-quality scan. Every .mdx file under docs/en-US/, blog/en-US/, devlog/en-US/, and authors/ was reviewed against CONTRIBUTING.md. Only high-confidence, mechanical fixes were applied — no prose was rewritten for voice/style, no code semantics were changed, and docs-templates/ was left untouched.

Before / After (by area)

core

  • Before: docs/en-US/core/index.mdx used a bare import Video from '@/components/Video' statement, which CI blocks (imports aren't allowed in MDX).
  • After: replaced with the working '<video controls src="..." />' pattern already used elsewhere in the repo.
  • Also fixed a sentence that was cut off mid-thought in locales.mdx, and a garbled sentence in quickstart.mdx ("check the enqueue the file" → "enqueue the file").

react-core-linter

  • Same import Video<video> fix in index.mdx and guides/quickstart.mdx.
  • Fixed a wording error in rules/static-string.mdx ("Registration functions" → "Translation functions", matching the rest of the page).

react-native

  • tutorials/quickstart.mdx and tutorials/quickstart-expo.mdx both claimed gt-react-native "does not export a pre-built <LocaleSelector> component" — this directly contradicted the same files' own later sections, the mini-shop tutorial, and the dedicated <LocaleSelector> reference page. Corrected to point at the real component.

next

  • Fixed several grammar/run-on sentences and typos across api/strings/tx.mdx, api/components/tx.mdx, api/config/with-gt-config.mdx (also fixed a withGTPropswithGTConfig naming slip, vercelVercel, and a stray underscore in _batchIntervalbatchInterval), guides/migration.mdx (mis-numbered list), tutorials/examples/currency-converter/*.mdx, and tutorials/examples/next-speedrun.mdx (capitalization/grammar).
  • Fixed a link in api/strings/tx.mdx that pointed getGT at the useGT page instead of the real get-gt reference page.
  • Fixed a heading-level inconsistency in api/types/dictionary-translation-options.mdx (### Next steps## Next steps, matching every sibling page).
  • Fixed a broken code-fence (mismatched backtick count) in guides/cache-components.mdx.

node

  • Fixed a broken sentence in api/strings/msg.mdx.

key-concepts

  • Fixed an inline-code example in dynamic-content.mdx where backslash-escaping broke the intended `¡Hola, ${name}!` code span.

api

  • 6 auto-generated API reference pages (branches/getBranchInfo, context/getContextStatus, context/shouldGenerateContext, files/getTranslationStatus, jobs/getJobsInfo, project/getProjectInfo) were missing the description frontmatter field that the other 16 pages in this section all have. Added matching descriptions.

blog

  • i18n-without-translation-files.mdx had the same bare import Video CI hard-fail, fixed the same way.
  • 7 fenced code blocks across gt-next.mdx, multilingual-nextjs-seo.mdx, and plurals.mdx were missing a language id; added bash/text as appropriate.

devlog

  • 3 more import Video CI hard-fails fixed (gt-react_v10_15_0, gt-react_v10_19_0, react-core-linter_v0_1_0).
  • 2 more bare code fences given language ids (gt-next_v6_3_0, gt-react_v10_18_0).
  • gt-i18n_v0_1_0.mdx had two dead placeholder (#) links with no real target; converted to plain inline code since no reference page exists yet for those functions.

authors

  • default.mdx and jackie.mdx were missing the required occupation field; added.
  • archie.mdx's twitter field pointed at a photo sub-page instead of the profile; fixed.

Not included (flagged for maintainer review, not auto-fixed)

A few larger/riskier findings surfaced by the scan were deliberately not touched in this PR, since they need product/maintainer judgment rather than a mechanical fix:

  • docs/en-US/react/ and docs/en-US/next/guides/ have a number of pages that are empty auto-generated stubs with real content sitting unused in docs-templates/ — looks like the template→page sync step hasn't been run for some frameworks.
  • A few examples in docs/en-US/python/guides/strings.mdx and docs/en-US/cli/ (config docs, --force flag description) appear to describe different behavior than their own API reference pages — needs an engineer to confirm actual behavior before editing.
  • docs/en-US/next/api/config/create-next-middleware.mdx has a code example that contradicts the prose above it (prefixDefaultLocale) — needs confirmation of the intended default before flipping it.

How

38 files changed across docs/en-US/, blog/en-US/, devlog/en-US/, and authors/. No file under docs-templates/ was touched. Verified with the repo's own scripts/validate-links.ts (all links valid) and the CI hard-fail grep patterns (script/iframe/object/embed/style tags, javascript: URLs — none found).

… docs/blog/devlog/authors

Daily automated docs-quality scan. Fixes:
- Removes literal `import Video` statements (CI hard-fail) in favor of the working <video> tag pattern, across core, react-core-linter, blog, and devlog
- Adds missing language ids to bare code fences (blog, devlog)
- Fixes mismatched code-fence backtick counts in next/guides/cache-components.mdx
- Fixes grammar/wording errors, a mistargeted link, and a wrong prop name across next, core, node, key-concepts, react-core-linter, react-native
- Fixes react-native's LocaleSelector docs, which incorrectly claimed no pre-built component exists
- Adds missing description frontmatter to 6 auto-generated API reference pages, matching the schema used by the other 16
- Adds missing occupation frontmatter to two author profiles and fixes a mistargeted twitter URL
- Removes two dead placeholder (#) links in a devlog entry

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