Skip to content

docs: daily scan fixes (2026-07-12)#356

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

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

Conversation

@claude

@claude claude Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Requested by Archie McKenzie · Slack thread

Automated daily docs-quality scan. One subagent reviewed each subsection under docs/en-US/, plus blog/en-US and devlog/en-US, against CONTRIBUTING.md's conventions. Only high-confidence, mechanical fixes were applied — no prose was rewritten for voice/style and no code semantics were changed.

Before / After

blog/en-US

  • gt-next.mdx: code fence had only a copy meta flag with no language id → added bash
  • multilingual-nextjs-seo.mdx: two bare code fences (URL list, directory tree) → added text
  • plurals.mdx: four bare code fences (example output strings) → added text

devlog/en-US

  • gt-next_v6_3_0.mdx: bare code fence (encoded message format example) → added text
  • gt-react_v10_18_0.mdx: bare code fence (translation output example) → added text

docs/en-US/next

  • api/config/with-gt-config.mdx: "vercel" → "Vercel" (proper noun)
  • tutorials/examples/next-speedrun.mdx: "Dev Api Keys" → "Dev API Keys"; "General translation uses cookies" → "General Translation uses cookies"
  • guides/migration.mdx: "a LLMs.txt" → "an LLMs.txt" (article before vowel sound); fixed a duplicated "2." in an ordered list → "3."

Not changed (flagged for maintainers, not fixed)

These were surfaced by the scan but intentionally left untouched — each needs an editorial or maintainer decision rather than a mechanical fix:

  • Recurring import Video from '@/components/Video'; outside a code fence in core/index.mdx, blog/i18n-without-translation-files.mdx, two devlog entries, and react-core-linter/index.mdx + guides/quickstart.mdx. This matches the "no import/export in MDX" restriction documented in CONTRIBUTING.md, but the repo's actual CI (.github/workflows/run-tests.yml) only greps for <script|iframe|object|embed|style> tags and javascript: URLs — it does not check for bare imports — and these pages are already merged and building successfully on main. Left as-is to avoid breaking working video embeds; worth reconciling CONTRIBUTING.md's documented rule with actual CI behavior.
  • docs/en-US/react-native/concepts/stand-alone.mdx, docs/en-US/react/concepts/stand-alone.mdx, docs/en-US/next/concepts/stand-alone.mdx: frontmatter description says "gt-react" in all three (should presumably read "gt-react-native" / "gt-next" for those sections). All three files are marked AUTO-GENERATED: Do not edit directly. Edit the template in content/docs-templates/ instead. — the real fix belongs in docs-templates/, which is out of scope for this scan.
  • docs/en-US/core/locales.mdx:44-45: a sentence trails off mid-thought ("However, the platform will only translate...").
  • docs/en-US/core/quickstart.mdx:109: garbled phrase, "check the enqueue the file" — likely an editing leftover.
  • docs/en-US/cli/download.mdx: --force and --force-download share an identical description, but translate.mdx documents them as distinct flags — looks like a copy-paste error.
  • docs/en-US/python/guides/strings.mdx: inconsistent naming for the same kwarg ($context in prose vs. context= in code samples vs. _context in the API reference).
  • docs/en-US/react-core-linter/rules/static-string.mdx:24: "Registration functions" appears to be a word-choice error for "Translation functions."
  • A few faqs.mdx files (core, react, react-native, sanity) open directly at ### (h3) with no ## (h2) — appears to be a consistent repo-wide FAQ convention rather than a per-file bug.
  • Several api/ reference pages under docs/en-US/api/ (branches, context, jobs, project) are missing a description frontmatter field, but they're Fumadocs-generated stubs ("Do not edit this file directly") — the fix belongs upstream in the OpenAPI spec.

How

19 subagents (one per docs/en-US/ subsection, plus blog/devlog/authors) each scanned every .mdx file in their scope for CONTRIBUTING.md compliance, CI hard-fail patterns, prose typos, and markdown/link hygiene, applying only zero-risk mechanical fixes directly and reporting everything else. Files touched: 3 in blog/en-US, 2 in devlog/en-US, 3 in docs/en-US/next.


Generated by Claude Code

Automated daily docs-quality scan across docs/en-US, blog/en-US, and
devlog/en-US. Applies only mechanical, zero-risk fixes:

- Add missing language ids to fenced code blocks (blog, devlog)
- Fix clear spelling/capitalization typos in prose (Vercel, API, General
  Translation, article usage) and a duplicate list number (next docs)

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