Skip to content

docs: fix typos, grammar, and style-guide violations across content#343

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

docs: fix typos, grammar, and style-guide violations across content#343
claude[bot] wants to merge 1 commit into
mainfrom
docs/daily-scan-2026-07-05

Conversation

@claude

@claude claude Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Requested by Archie McKenzie · Slack thread

Summary

Daily automated documentation scan. One subagent reviewed each subsection under docs/en-US/ plus blog/en-US, devlog/en-US, and authors/ against CONTRIBUTING.md and CLAUDE.md. Auto-generated files (docs-templates/ and files carrying the AUTO-GENERATED banner) were skipped since editing them wouldn't survive the next generation pass. 45 files touched, all mechanical/high-confidence fixes — no voice/style rewrites, no code-semantics changes.

Before → After, by subsection

core

  • class/constructor.mdx: garbled numbered-list sentence ("locale codes which, (2) can override") → cleaned up.
  • class/methods/formatting/format-message.mdx, functions/formatting/format-message.mdx: "Format.JS" → "FormatJS" (correct product name); standalone-function doc description fixed to describe a function, not a method.
  • class/methods/formatting/format-date-time.mdx: empty "Next steps" section given content (matches sibling pages' pattern).
  • locales.mdx: completed a sentence that was cut off mid-thought; fixed inconsistent capitalization of "list of supported locales".
  • quickstart.mdx: missing "and" between two instructions; a heading that had run on into the following paragraph, splitting a sentence; a duplicated/garbled phrase ("later check the enqueue the file").

next

  • api/config/with-gt-config.mdx: wrong function name withGTPropswithGTConfig; "vercel" → "Vercel".
  • api/components/tx.mdx, api/strings/tx.mdx: garbled trade-off sentence cleaned up.
  • api/strings/tx.mdx: getGT link pointed at the wrong page.
  • api/strings/get-gt.mdx, api/strings/get-messages.mdx, concepts/environments.mdx: "fallback" used as a verb → "fall back"; "Translations strings ... happen" → "Translating strings ... happens".
  • api/types/dictionary-translation-options.mdx: "Next steps" heading demoted to H3 by mistake → back to H2, matching sibling pages.
  • guides/migration.mdx: duplicate list number (1, 2, 2 → 1, 2, 3); "a LLMs.txt" → "an LLMs.txt".
  • tutorials/examples/currency-converter/preptx.mdx, tutorials/examples/next-speedrun.mdx: "api key"/"project id" → "API key"/"project ID"; "General translation" → "General Translation"; "jsx" → "JSX".

react / react-native

  • api/components/gtprovider.mdx (both): subject-verb agreement ("Render settings controls" → "control"); removed a link that pointed back to the same page it was on.
  • react-native/api/helpers/get-locale-from-native-store.mdx: doc referenced a localeCookieName prop that doesn't exist on React Native's <GTProvider> (copy-pasted from the web docs) → corrected to "custom storage key".

node

  • api/strings/msg.mdx: same "Translating strings ... happens" grammar fix.
  • guides/strings.mdx: frontmatter said "two approaches" while the body describes three; a callout claim that two approaches are "identical" was inconsistent with a third approach shown in the same table.

cli

  • stage.mdx: options table was missing the closing | on each data row, making it ragged.
  • faqs.mdx: five questions were H3 with no parent H2 → promoted to H2 to match the rest of the CLI docs.

locadex: "Next.js App router" → "Next.js App Router" (capitalization).
key-concepts: "(ie," → "(i.e.," for consistency with the very next line.
sanity: "converts document to HTML" → "converts the document to HTML".

blog

  • ai-chatbot.mdx: heading title-case → sentence case.
  • gt-next.mdx: heading level skipped straight to H3/H4 with no H2 → promoted one level.

devlog

  • Four grammar fixes (wrong article before "SWC", a comma splice, a duplicated "the reading", "in the off chance" → "on the off chance").
  • A 4-space-indented numbered list that Markdown would render as a code block, not a list → de-indented.
  • ~40 headings across 14 release-note files were Title Case instead of the required sentence case (e.g. "## Cached Components" → "## Cached components") — brought in line with CLAUDE.md's heading rule.

authors

  • jackie.mdx: missing occupation field, added as "Software Engineer" (matches the bio text).
  • archie.mdx: Twitter/X link pointed at the profile-photo lightbox instead of the profile.

Not fixed (needs a human)

  • authors/default.mdx (the generic "Team" author) is also missing occupation, but there's no single correct value for a placeholder team account, so it was left alone.

How

  • Ran the repo's own scripts/validate-links.ts before and after — all links valid both times.
  • Confirmed no CI-restricted patterns (<script>/<iframe>/etc., javascript: URLs) were introduced.
  • Ran pnpm build:content — builds clean.

…cross docs/blog/devlog

Daily automated content scan across all docs/en-US subsections, blog, devlog,
and authors. Fixes grouped by category:

- Grammar/prose: garbled or duplicated phrases, subject-verb agreement,
  comma splices, incomplete sentences, wrong articles (a/an)
- Style-guide compliance (CLAUDE.md): sentence-case headings, product name
  capitalization (FormatJS, Vercel, API, Next.js App Router, General
  Translation), "fall back" as a verb, heading-level fixes
- Factual/link accuracy: wrong function name (withGTConfig), self-referential
  link removed, incorrect getGT link target, nonexistent localeCookieName
  prop reference corrected, frontmatter occupation field added
- Markdown hygiene: malformed table missing trailing pipes, duplicate list
  number, misplaced heading text bleeding into body prose

Verified: link validator passes, no CI-restricted patterns introduced,
content app builds successfully.
@claude claude Bot requested a review from a team as a code owner July 5, 2026 15:23
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.

1 participant