Daily docs scan: fix CI-blocking imports, broken code examples, and typos#344
Closed
claude[bot] wants to merge 1 commit into
Closed
Daily docs scan: fix CI-blocking imports, broken code examples, and typos#344claude[bot] wants to merge 1 commit into
claude[bot] wants to merge 1 commit into
Conversation
…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
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 docs scan. Fixed high-confidence documentation issues found across
docs/en-US/,blog/en-US/,devlog/en-US/, andauthors/.CI-blocking fixes
import Video from '@/components/Video';statement from 7 files. Rawimport/exportstatements in MDX bodies are a CI hard-fail perCONTRIBUTING.md, and<Video>is already available as a global MDX component (confirmed bydocs/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 usedawaitwithout being declaredasync(a syntax error if copied). After: addedasync.api/config/with-gt-config.mdx— Before: examplegt.config.jsonhad a trailing comma (invalid JSON); prop referenced as_batchIntervalbut documented elsewhere asbatchInterval. After: fixed both.api/middleware/create-next-middleware.mdx— Before: the "Remove default locale prefix" example setprefixDefaultLocale: true, contradicting the surrounding prose. After: set tofalse.api/dictionary/use-translations.mdx— Before: code comment said// Hello, Alicebut the dictionary defines"Hello, Bob". After: comment corrected.guides/dictionaries.mdx— Before: server-component example callsgetTranslations()intod, but the JSX referenced an undefinedt. After: usesd.api/strings/tx.mdx,api/components/tx.mdx— Before:getGTlinks pointed at theuseGTpage; 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:$contextwas 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/coreclass/methods/translation/setup-project.mdx— Before: example readjobStatus.jobs[0].status, butcheckJobStatusreturns a flat array per its own reference page. After:jobStatus[0].status.class/methods/formatting/format-date-time.mdx— Removed a leftover empty## Next stepsheading with no content underneath (the same links already exist under## Related methods).docs/en-US/pythonapi/t-fallback.mdx— Before: example imported from a non-existentgt_i18npackage. After:gt_flask/gt_fastapi, matching the siblingt.mdxreference page.guides/strings.mdx— Before: examples usedcontext=/$context, but the actual GT option (perapi/t.mdx) is_context. After: fixed all five occurrences.docs/en-US/sanityguides/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 bothgtprovider.mdxfiles; cleaned up inconsistent list-marker style inreact-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 requiredoccupationfrontmatter field todefault.mdxandjackie.mdx; fixed a malformed Twitter URL (stray/photosuffix) inarchie.mdx.blog/en-US/— added language ids to 6 bare fenced code blocks acrossgt-next.mdx,plurals.mdx, andmultilingual-nextjs-seo.mdx.How
Touched 48
.mdxfiles acrossdocs/en-US/{core,next,react,react-native,cli,python,sanity,react-core-linter,locadex,overview,key-concepts},blog/en-US/,devlog/en-US/, andauthors/. Nodocs-templates/files were touched. Verified with the repo's ownscripts/validate-links.ts(all links valid) after applying changes.Found via 18 parallel documentation-scan agents (one per docs subsection) auditing against
CONTRIBUTING.mdconventions; every fix listed above was independently verified against the actual repo content before being applied — nothing here is a guess.