Skip to content

docs: fix documentation quality issues (daily scan 2026-06-26)#328

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

docs: fix documentation quality issues (daily scan 2026-06-26)#328
claude[bot] wants to merge 1 commit into
mainfrom
docs/daily-scan-2026-06-26

Conversation

@claude

@claude claude Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

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 import statements in MDX body blocked by CI:

  • docs/en-US/core/index.mdx — removed import Video from @/components/Video
  • docs/en-US/react-core-linter/index.mdx — same
  • docs/en-US/react-core-linter/guides/quickstart.mdx — same
  • blog/en-US/i18n-without-translation-files.mdx — same
  • devlog/en-US/react-core-linter_v0_1_0.mdx — same
  • devlog/en-US/gt-react_v10_15_0.mdx — same
  • devlog/en-US/gt-react_v10_19_0.mdx — same

Heading 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 fixed
  • api/config/with-gt-config.mdx — Notes used _batchInterval; actual prop is batchInterval
  • api/dictionary/get-translations.mdx — non-async function calling await; added async
  • guides/dictionaries.mdx — server component called t(...) after assigning const d; fixed to d(...)

node (2 fixes):

  • guides/strings.mdx — description said "Two approaches" but body lists three
  • api/strings/msg.mdx — typo "Translations strings" → "Translating strings"

react / react-native (3 fixes):

  • react/api/components/gtprovider.mdx — self-referential "Learn more [here]" link removed
  • react-native/api/components/gtprovider.mdx — same

cli / core / locadex / overview / platform / python (6 fixes):

  • cli/stage.mdx — inline code stageTranslations : true had spurious space before colon
  • core/locales.mdx — truncated sentence completed
  • core/quickstart.mdx — "check the enqueue the file" garbled; fixed
  • platform/supported-locales.mdx — trailing space in heading removed
  • python/guides/strings.mdx — heading/prose used $context; actual kwarg is context

blog / devlog (6 fixes):

  • blog/gt-next.mdx — bare ``` copy```bash copy
  • blog/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 import statements (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 (missing occupation field).

- 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
@claude
claude Bot requested a review from a team as a code owner June 26, 2026 15:17
@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