Skip to content

docs: daily scan fixes (2026-07-11)#355

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

docs: daily scan fixes (2026-07-11)#355
claude[bot] wants to merge 1 commit into
mainfrom
docs/daily-scan-2026-07-11

Conversation

@claude

@claude claude Bot commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

Requested by Archie McKenzie · Slack thread

Daily automated documentation-quality scan. All 19 docs subsections (docs/en-US/*, blog/en-US, devlog/en-US, authors/) were reviewed against CONTRIBUTING.md; only high-confidence, conservative fixes are included here.

Before / After

core

  • index.mdx: removed a leftover import Video from '@/components/Video'; line — imports are a CI hard-fail in MDX and the component doesn't need importing.
  • locales.mdx: removed a dangling, cut-off sentence ("However, the platform will only translate").
  • quickstart.mdx: fixed a missing "and" ("...api-keys) click..." → "...api-keys) and click...") and a garbled phrase ("check the enqueue the file" → "enqueue the file").

react-core-linter

  • index.mdx, guides/quickstart.mdx: removed leftover import Video ... lines (CI hard-fail).

overview

  • index.mdx: fixed company name spelling "Clickhouse" → "ClickHouse".
  • faqs.mdx: added missing comma ("Yes you can!" → "Yes, you can!").

key-concepts

  • dynamic-content.mdx: fixed an inline code span that had backslash-escaped backticks/braces so it renders as code instead of literal backslashes.

api

  • Added the required description frontmatter field to 6 auto-generated reference pages that were missing it: branches/getBranchInfo.mdx, context/getContextStatus.mdx, context/shouldGenerateContext.mdx, files/getTranslationStatus.mdx, jobs/getJobsInfo.mdx, project/getProjectInfo.mdx.

sanity

  • guides/serialization.mdx: fixed a missing article ("converts document to HTML" → "converts the document to HTML").

next

  • api/components/tx.mdx, api/strings/tx.mdx: fixed an identical garbled sentence ("...to load is significantly slower." → "...to load.").
  • api/config/with-gt-config.mdx: fixed a missing subject pronoun ("is received will reroute" → "is received, it will reroute").
  • guides/migration.mdx: fixed a duplicate "2." in an ordered list (should be 1, 2, 3).

node

  • api/strings/msg.mdx: fixed "fallback" used as a verb → "fall back"; fixed a subject-verb agreement error ("Translations strings ... happen" → "Translating strings ... happens"); added a missing terminal period.

blog

  • i18n-without-translation-files.mdx: removed a leftover import Video ... line (CI hard-fail; component unused in this post).
  • gt-next.mdx, multilingual-nextjs-seo.mdx, plurals.mdx: added language ids (bash/text) to 7 bare code fences.

devlog

  • gt-react_v10_15_0.mdx, gt-react_v10_19_0.mdx, react-core-linter_v0_1_0.mdx: removed leftover import Video ... lines (CI hard-fail).
  • gt-i18n_v0_1_0.mdx: fixed two links pointing to a dead # placeholder anchor — de-linked to plain code text.
  • gt-next_v6_2_0.mdx: fixed a 2-item list that was over-indented (rendering as a code block instead of a list) and mis-numbered.
  • gt-next_v6_10_0.mdx: fixed a comma splice and a doubled "the" ("from the reading the URL path" → "from reading the URL path").
  • gt-next_v6_3_0.mdx, gt-react_v10_18_0.mdx: added language id (text) to 2 bare code fences.

authors

  • archie.mdx: fixed a Twitter URL that pointed to a photo-viewer sub-path instead of the profile.
  • default.mdx, jackie.mdx: added the required occupation frontmatter field, which was missing.

Not changed (reviewed, intentionally excluded)

Several subagents flagged FAQ-style pages (and a couple of guide pages) for "skipping" from an implicit h1 straight to h3 with no h2 in between. This pattern is consistent across 7+ independent sections (core, react, react-native, cli, sanity, overview, locadex FAQ pages, plus a couple of guides), which strongly suggests it's a deliberate template/convention rather than a bug — and fixing it properly would mean renumbering every heading in each file rather than a safe one-line change. Left untouched pending a maintainer decision.

How

Files touched are listed above, grouped by section. Every change is a minimal, targeted edit (frontmatter field, one sentence/phrase, or a code-fence language id) — no rewrites of voice/style, no code-semantics changes, docs-templates/ untouched.


Generated by Claude Code

…docs

Daily automated content scan. Fixes:
- Remove leftover import statements in MDX (CI hard-fail): core, react-core-linter,
  blog, devlog
- Add missing frontmatter description to 6 api/ reference pages and missing
  occupation to 2 author profiles; fix a malformed twitter URL
- Add language ids to bare code fences: blog, devlog
- Fix broken placeholder links, malformed list indentation/numbering, and
  garbled/ungrammatical prose across core, next, node, sanity, overview,
  key-concepts, and devlog

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Da8rYmadJD38kcC1kfNi8Y
@claude
claude Bot requested a review from a team as a code owner July 11, 2026 15:16
@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