docs: fix documentation quality issues (daily scan 2026-06-26)#328
Closed
claude[bot] wants to merge 1 commit into
Closed
docs: fix documentation quality issues (daily scan 2026-06-26)#328claude[bot] wants to merge 1 commit into
claude[bot] wants to merge 1 commit into
Conversation
- Fix CI hard-fails: remove bare import statements from 7 MDX files (core/index, react-core-linter/index, react-core-linter/guides/quickstart, blog/i18n-without-translation-files, devlog/react-core-linter_v0_1_0, devlog/gt-react_v10_15_0, devlog/gt-react_v10_19_0) - Fix heading level skips (h3 with no h2): cli/faqs, overview/faqs, react/faqs, react-native/faqs, sanity/faqs, locadex/mintlify - Fix garbled sentence in next/api/components/tx and next/api/strings/tx - Fix wrong component name (<T> -> <Tx>) in next/api/components/tx - Fix wrong variable name (t -> d) in next/guides/dictionaries server block - Fix non-async function using await in next/api/dictionary/get-translations - Fix _batchInterval -> batchInterval in next/api/config/with-gt-config - Fix truncated sentence in core/locales - Fix description mismatch (Two -> Three) in node/guides/strings - Fix prose typos: cli/stage (stageTranslations spacing), node/api/strings/msg, devlog/gt-next_v6_10_0 - Fix $context -> context in python/guides/strings heading/prose - Remove self-referential links from react and react-native GTProvider pages - Add missing language IDs to bare code fences: blog/gt-next, blog/plurals, devlog/gt-next_v6_3_0, devlog/gt-react_v10_18_0 - Fix trailing space in platform/supported-locales heading
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
Automated daily docs scan found 33 issues across 32 files. All high-confidence fixes applied.
Before / After by subsection
CI Hard-Fails (7 files) — bare
importstatements in MDX body blocked by CI:docs/en-US/core/index.mdx— removedimport Video from @/components/Videodocs/en-US/react-core-linter/index.mdx— samedocs/en-US/react-core-linter/guides/quickstart.mdx— sameblog/en-US/i18n-without-translation-files.mdx— samedevlog/en-US/react-core-linter_v0_1_0.mdx— samedevlog/en-US/gt-react_v10_15_0.mdx— samedevlog/en-US/gt-react_v10_19_0.mdx— sameHeading level skips (6 files) — body started at h3 with no h2:
docs/en-US/cli/faqs.mdx,overview/faqs.mdx,react/faqs.mdx,react-native/faqs.mdx,sanity/faqs.mdx— all###→##docs/en-US/locadex/mintlify.mdx— all step headings###→##next (5 fixes):
api/components/tx.mdx— garbled sentence fixed; wrong component name<T>→<Tx>api/strings/tx.mdx— same garbled sentence fixedapi/config/with-gt-config.mdx— Notes used_batchInterval; actual prop isbatchIntervalapi/dictionary/get-translations.mdx— non-asyncfunction callingawait; addedasyncguides/dictionaries.mdx— server component calledt(...)after assigningconst d; fixed tod(...)node (2 fixes):
guides/strings.mdx— description said "Two approaches" but body lists threeapi/strings/msg.mdx— typo "Translations strings" → "Translating strings"react / react-native (3 fixes):
react/api/components/gtprovider.mdx— self-referential "Learn more [here]" link removedreact-native/api/components/gtprovider.mdx— samecli / core / locadex / overview / platform / python (6 fixes):
cli/stage.mdx— inline codestageTranslations : truehad spurious space before coloncore/locales.mdx— truncated sentence completedcore/quickstart.mdx— "check the enqueue the file" garbled; fixedplatform/supported-locales.mdx— trailing space in heading removedpython/guides/strings.mdx— heading/prose used$context; actual kwarg iscontextblog / devlog (6 fixes):
blog/gt-next.mdx— bare``` copy→```bash copyblog/plurals.mdx,devlog/gt-next_v6_3_0.mdx,devlog/gt-react_v10_18_0.mdx— bare code fences → ````text`devlog/gt-next_v6_10_0.mdx— typo "from the reading the URL" → "from reading the URL"How
32 files touched. Changes limited to: removing bare
importstatements (CI compliance), promoting###to##where no##exists, correcting garbled/truncated prose, fixing wrong variable/component names in code examples, adding language IDs to bare code fences, fixing typos and a self-referential link.Skipped (needs editorial input):
react-native/concepts/stand-alone.mdx(auto-generated — edit template instead),next/tutorials/dictionary/setup.mdx(under-construction stub),authors/jackie.mdx+authors/default.mdx(missingoccupationfield).