Skip to content

docs: daily content-quality fixes (2026-07-03)#339

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

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

Conversation

@claude

@claude claude Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Requested by Archie McKenzie · Slack thread

Daily automated docs-quality scan. 19 subsections (all docs/en-US/*, blog/en-US, devlog/en-US, authors) were scanned against CONTRIBUTING.md conventions. Below is a plain-language before/after summary, grouped by subsection.

Before → After

CI-breaking leftover import Video statements (would fail the build) — removed the unused import in each file, kept the existing <Video> tag:

  • docs/en-US/core/index.mdx
  • docs/en-US/react-core-linter/index.mdx
  • docs/en-US/react-core-linter/guides/quickstart.mdx
  • blog/en-US/i18n-without-translation-files.mdx
  • devlog/en-US/gt-react_v10_15_0.mdx
  • devlog/en-US/gt-react_v10_19_0.mdx
  • devlog/en-US/react-core-linter_v0_1_0.mdx

Code fences missing a language id — added bash/txt/text tags:

  • blog/en-US/gt-next.mdx, blog/en-US/multilingual-nextjs-seo.mdx (x2), blog/en-US/plurals.mdx (x4)
  • devlog/en-US/gt-next_v6_3_0.mdx, devlog/en-US/gt-react_v10_18_0.mdx

Missing frontmatter description (required by CONTRIBUTING.md) — added a one-line description to 6 auto-generated API reference pages under docs/en-US/api/ (branches/getBranchInfo, context/getContextStatus, context/shouldGenerateContext, files/getTranslationStatus, jobs/getJobsInfo, project/getProjectInfo).

Orphaned sidebar pagedocs/en-US/locadex/faqs.mdx existed but wasn't listed in docs/en-US/locadex/meta.json; added it.

Grammar / clarity / broken-reference fixes:

  • docs/en-US/key-concepts/dynamic-content.mdx — un-escaped a mangled inline code span (\`¡Hola, $\{name\}!\``¡Hola, ${name}!`)
  • docs/en-US/node/api/get-translations.mdxnpx gtx translatenpx gt translate (wrong package name)
  • docs/en-US/react-core-linter/rules/static-string.mdx — "Registration functions" → "Translation functions"
  • docs/en-US/react/api/components/gtprovider.mdx — subject/verb agreement fix; removed a self-referential "Learn more here" link
  • docs/en-US/next/api/components/tx.mdx + docs/en-US/next/api/strings/tx.mdx — fixed a run-on sentence and a mislabeled link (getGT was linking to the use-gt page instead of get-gt)
  • docs/en-US/next/api/config/with-gt-config.mdxwithGTPropswithGTConfig (wrong identifier), a dangling clause, and "vercel" → "Vercel"
  • docs/en-US/next/guides/migration.mdx — fixed a numbered list (1, 2, 2 → 1, 2, 3) and "a LLMs.txt" → "an LLMs.txt"
  • docs/en-US/next/index.mdx — "Both X, Y, and Z" (3 items) → "X, Y, and Z all"
  • docs/en-US/next/tutorials/examples/next-speedrun.mdx — broken correlative construction, "Api" → "API", "General translation" → "General Translation"
  • docs/en-US/react-native/tutorials/quickstart.mdx + quickstart-expo.mdx — corrected a factually wrong claim that gt-react-native has no pre-built <LocaleSelector> component (it does — referenced elsewhere in the same docs)
  • devlog/en-US/gt-next_v6_10_0.mdx — fixed a comma splice and a duplicated "the reading"
  • devlog/en-US/gt-next_v6_2_0.mdx — fixed a malformed numbered list (stray tab/indentation was rendering it as a code block instead of a list)
  • devlog/en-US/gt-i18n_v0_1_0.mdx — removed two dead (#) placeholder links
  • authors/archie.mdx — fixed a malformed Twitter URL (.../photo → profile URL)

Not fixed (flagged for a human, out of scope for an automated conservative pass)

  • docs/en-US/core/locales.mdx has a sentence that trails off unfinished ("the platform will only translate...") — needs a human to supply the actual ending.
  • docs/en-US/python/guides/strings.mdx has several code examples whose function-call signatures don't match the documented API (decode_vars, declare_var, derive, and a context/_context naming mismatch) — these are code-semantics issues that need verification against the actual library, not a docs-wording fix.
  • Every file in authors/ references an avatar path (/static/avatars/*.png) that doesn't resolve to any file in this repo — likely hosted externally, but worth a maintainer sanity check.
  • authors/default.mdx and authors/jackie.mdx are missing the required occupation frontmatter field — left blank rather than guessing a title.

How

Fixes were applied directly to the affected .mdx/.json files; no code samples' runtime behavior was changed, and docs-templates/ was left untouched.

Fixes CI-breaking leftover import statements, missing code-fence
language ids, missing API frontmatter descriptions, an orphaned
sidebar page, and assorted grammar/link errors found in the daily
docs scan.
@claude
claude Bot requested a review from a team as a code owner July 3, 2026 15:19
@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