docs: daily content-quality fixes (2026-07-02)#337
Closed
claude[bot] wants to merge 1 commit into
Closed
Conversation
… 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
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
Summary
Daily automated documentation-quality scan. Every
.mdxfile underdocs/en-US/,blog/en-US/,devlog/en-US/, andauthors/was reviewed againstCONTRIBUTING.md. Only high-confidence, mechanical fixes were applied — no prose was rewritten for voice/style, no code semantics were changed, anddocs-templates/was left untouched.Before / After (by area)
core
docs/en-US/core/index.mdxused a bareimport Video from '@/components/Video'statement, which CI blocks (imports aren't allowed in MDX).'<video controls src="..." />'pattern already used elsewhere in the repo.locales.mdx, and a garbled sentence inquickstart.mdx("check the enqueue the file" → "enqueue the file").react-core-linter
import Video→<video>fix inindex.mdxandguides/quickstart.mdx.rules/static-string.mdx("Registration functions" → "Translation functions", matching the rest of the page).react-native
tutorials/quickstart.mdxandtutorials/quickstart-expo.mdxboth claimedgt-react-native"does not export a pre-built<LocaleSelector>component" — this directly contradicted the same files' own later sections, themini-shoptutorial, and the dedicated<LocaleSelector>reference page. Corrected to point at the real component.next
api/strings/tx.mdx,api/components/tx.mdx,api/config/with-gt-config.mdx(also fixed awithGTProps→withGTConfignaming slip,vercel→Vercel, and a stray underscore in_batchInterval→batchInterval),guides/migration.mdx(mis-numbered list),tutorials/examples/currency-converter/*.mdx, andtutorials/examples/next-speedrun.mdx(capitalization/grammar).api/strings/tx.mdxthat pointedgetGTat theuseGTpage instead of the realget-gtreference page.api/types/dictionary-translation-options.mdx(### Next steps→## Next steps, matching every sibling page).guides/cache-components.mdx.node
api/strings/msg.mdx.key-concepts
dynamic-content.mdxwhere backslash-escaping broke the intended`¡Hola, ${name}!`code span.api
branches/getBranchInfo,context/getContextStatus,context/shouldGenerateContext,files/getTranslationStatus,jobs/getJobsInfo,project/getProjectInfo) were missing thedescriptionfrontmatter field that the other 16 pages in this section all have. Added matching descriptions.blog
i18n-without-translation-files.mdxhad the same bareimport VideoCI hard-fail, fixed the same way.gt-next.mdx,multilingual-nextjs-seo.mdx, andplurals.mdxwere missing a language id; addedbash/textas appropriate.devlog
import VideoCI hard-fails fixed (gt-react_v10_15_0,gt-react_v10_19_0,react-core-linter_v0_1_0).gt-next_v6_3_0,gt-react_v10_18_0).gt-i18n_v0_1_0.mdxhad two dead placeholder (#) links with no real target; converted to plain inline code since no reference page exists yet for those functions.authors
default.mdxandjackie.mdxwere missing the requiredoccupationfield; added.archie.mdx'stwitterfield 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/anddocs/en-US/next/guides/have a number of pages that are empty auto-generated stubs with real content sitting unused indocs-templates/— looks like the template→page sync step hasn't been run for some frameworks.docs/en-US/python/guides/strings.mdxanddocs/en-US/cli/(config docs,--forceflag 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.mdxhas 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/, andauthors/. No file underdocs-templates/was touched. Verified with the repo's ownscripts/validate-links.ts(all links valid) and the CI hard-fail grep patterns (script/iframe/object/embed/style tags,javascript:URLs — none found).