docs: daily content-quality fixes (2026-07-03)#339
Closed
claude[bot] wants to merge 1 commit into
Closed
Conversation
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.
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 docs-quality scan. 19 subsections (all
docs/en-US/*,blog/en-US,devlog/en-US,authors) were scanned againstCONTRIBUTING.mdconventions. Below is a plain-language before/after summary, grouped by subsection.Before → After
CI-breaking leftover
import Videostatements (would fail the build) — removed the unused import in each file, kept the existing<Video>tag:docs/en-US/core/index.mdxdocs/en-US/react-core-linter/index.mdxdocs/en-US/react-core-linter/guides/quickstart.mdxblog/en-US/i18n-without-translation-files.mdxdevlog/en-US/gt-react_v10_15_0.mdxdevlog/en-US/gt-react_v10_19_0.mdxdevlog/en-US/react-core-linter_v0_1_0.mdxCode fences missing a language id — added
bash/txt/texttags: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.mdxMissing frontmatter
description(required by CONTRIBUTING.md) — added a one-line description to 6 auto-generated API reference pages underdocs/en-US/api/(branches/getBranchInfo,context/getContextStatus,context/shouldGenerateContext,files/getTranslationStatus,jobs/getJobsInfo,project/getProjectInfo).Orphaned sidebar page —
docs/en-US/locadex/faqs.mdxexisted but wasn't listed indocs/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.mdx—npx gtx translate→npx 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" linkdocs/en-US/next/api/components/tx.mdx+docs/en-US/next/api/strings/tx.mdx— fixed a run-on sentence and a mislabeled link (getGTwas linking to theuse-gtpage instead ofget-gt)docs/en-US/next/api/config/with-gt-config.mdx—withGTProps→withGTConfig(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 "aLLMs.txt" → "anLLMs.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 thatgt-react-nativehas 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 linksauthors/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.mdxhas 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.mdxhas several code examples whose function-call signatures don't match the documented API (decode_vars,declare_var,derive, and acontext/_contextnaming mismatch) — these are code-semantics issues that need verification against the actual library, not a docs-wording fix.authors/references anavatarpath (/static/avatars/*.png) that doesn't resolve to any file in this repo — likely hosted externally, but worth a maintainer sanity check.authors/default.mdxandauthors/jackie.mdxare missing the requiredoccupationfrontmatter field — left blank rather than guessing a title.How
Fixes were applied directly to the affected
.mdx/.jsonfiles; no code samples' runtime behavior was changed, anddocs-templates/was left untouched.