Skip to content

Daily docs scan: fix CI hard-fails, typos, and heading issues#353

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

Daily docs scan: fix CI hard-fails, typos, and heading issues#353
claude[bot] wants to merge 1 commit into
mainfrom
docs/daily-scan-2026-07-10

Conversation

@claude

@claude claude Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Requested by Archie McKenzie · Slack thread

Summary

Automated daily scan of docs/en-US/* for CONTRIBUTING.md compliance, CI hard-fails, typos, and markdown issues. High-confidence fixes only — 18 files touched.

Before / After by subsection

core

  • Before: core/index.mdx had a live import Video from '@/components/Video' statement in MDX — a CI hard-fail (Video is already globally registered, so it rendered fine but would fail the import/export lint). After: import removed.
  • Before: core/locales.mdx skipped from the implicit h1 title straight to h3 sub-headings. After: promoted to h2 to match the rest of the docs.
  • Before: core/quickstart.mdx had a missing "and" ("...page click Create API Key"), a duplicated-phrase typo ("check the enqueue the file"), and a mis-used #### heading inside a <Callout>. After: grammar fixed, heading converted to bold lead-in text.
  • Before: core/class/methods/locales/determine-locale.mdx and core/functions/locales/determine-locale.mdx example comments said preference ['fr-CA', 'es-MX', ...] resolves to 'es-ES'. After: corrected to 'fr-FR' (first-preference language match, consistent with the method's documented behavior).
  • Before: core/class/methods/formatting/format-date-time.mdx had a dangling empty ## Next steps heading. After: removed.

next

  • Before: next/api/components/tx.mdx and next/api/strings/tx.mdx had a garbled sentence ("...delay while waiting for an on-demand translation to load is significantly slower"). After: added "which" for correct grammar.
  • Before: next/guides/migration.mdx had a mis-numbered list (two "2." items). After: renumbered to "3."

react / react-native

  • Before: both gtprovider.mdx API pages had a subject-verb agreement error ("Render settings controls..."). After: "control".

locadex

  • Before: locadex/mintlify.mdx and locadex/next.mdx skipped from the page title straight to h3 step headings, and mintlify.mdx had two more orphaned h3 sections. After: added a ## Installation heading and promoted the orphaned sections to h2.

react-core-linter

  • Before: react-core-linter/index.mdx and react-core-linter/guides/quickstart.mdx had live import Video from '@/components/Video' statements — a CI hard-fail. After: imports removed (component is globally registered).

overview

  • Before: overview/index.mdx had a brand-name typo, "Clickhouse". After: corrected to "ClickHouse".

python

  • Before: python/guides/strings.mdx referred to the context kwarg as $context in prose/heading, inconsistent with the code example just below. After: corrected to context.

api

  • Root cause fix instead of hand-editing generated output: 6 generated api/*.mdx reference pages (getBranchInfo, getContextStatus, shouldGenerateContext, getTranslationStatus, getJobsInfo, getProjectInfo) were missing a frontmatter description, because their corresponding operations in docs/en-US/api/openapi.yaml had a summary but no description. Added the missing description field to each of those 6 operations in the spec so the next Fumadocs generation run picks them up correctly. The generated .mdx files themselves were left untouched per their own "do not edit directly" notice.

Not fixed (flagged for human review, left untouched — low confidence or needs a content-owner call)

  • python/guides/strings.mdx: possible kwarg-name mismatch (context= vs _context) between a guide and the API reference — couldn't confirm which is correct from docs alone.
  • python/guides/strings.mdx: msg() links point to a page that doesn't document msg().
  • react/react-native gtprovider.mdx: "Learn more [here]" links to the same page (likely copy-paste artifact).
  • react-native/api/helpers/get-locale-from-native-store.mdx: references a localeCookieName prop not present in the GTProvider props reference.
  • sanity: plugin-config.mdx and guides/configuration.mdx give contradictory descriptions of singletonMapping's default behavior.
  • locadex/auto-merge.mdx: an image alt-text string has an oddly placed quote.
  • core/locales.mdx: one sentence ("However, the platform will only translate") is truncated mid-thought.
  • core/class/methods/translation/check-job-status.mdx: "Notes" bullets read as copied from a different method's docs.
  • core/class/constructor.mdx: a custom-locale-mapping example maps en-US to a Mandarin name/French flag (likely a copy-paste mistake, correct values unknown).
  • next/tutorials/dictionary/setup.mdx: page body is just a "under construction" placeholder (content gap, not a lint issue).

How

18 files touched across core, next, react, react-native, locadex, react-core-linter, overview, python, and api (spec only). Verified with the repo's own scripts/validate-links.ts (all 437 content files, zero broken links) and a YAML syntax check on openapi.yaml.


Generated by Claude Code

- Remove live import statements in MDX (CI hard-fail) in core/index,
  react-core-linter/index, react-core-linter/guides/quickstart
- Fix skipped heading levels in core/locales.mdx and locadex guides
- Fix grammar/typos in core/quickstart, next/tx docs, overview,
  python/strings, react & react-native gtprovider docs
- Fix incorrect example output in core determine-locale docs
- Fix mis-numbered list in next/guides/migration
- Add missing OpenAPI operation descriptions (root cause of blank
  frontmatter description on 6 generated api/*.mdx pages)
@claude
claude Bot requested a review from a team as a code owner July 10, 2026 15:21
@claude

claude Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor Author

Daily docs scan summary (posted here because Slack delivery to C0AEUCELSUT failed this run — session's Slack tools were unavailable)

Issues found → fixed, by subsection:

  • core (77 files): 12 → 8 fixed
  • next (78 files): 4 → 3 fixed
  • api (22 files): 6 → 0 mdx edits, fixed at the root cause instead (added missing description to 6 operations in openapi.yaml; the generated .mdx pages are marked do-not-edit)
  • locadex (7 files): 3 → 2 fixed
  • react-core-linter (5 files): 2 → 2 fixed (both were CI hard-fail import statements in MDX)
  • react (52 files): 3 → 1 fixed
  • react-native (53 files): 3 → 1 fixed
  • python (17 files): 3 → 1 fixed
  • overview (4 files): 2 → 1 fixed
  • sanity (6 files): 1 found, 0 fixed (flagged only)
  • cli, node, platform, key-concepts, tanstack-start, next-lint: clean

18 files changed total. Verified with scripts/validate-links.ts (437 files, 0 broken links) and a YAML syntax check on the OpenAPI spec.

Lower-confidence issues left untouched for human review are listed in the PR description above.

Auto-merge: could not be enabled via API in this environment (GraphQL restricted to a pinned set of PR-review operations; no REST equivalent exists for enablePullRequestAutoMerge). Repo is squash-only — needs a manual squash-merge.

@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