docs: fix typos, grammar, and style-guide violations across content#343
Open
claude[bot] wants to merge 1 commit into
Open
docs: fix typos, grammar, and style-guide violations across content#343claude[bot] wants to merge 1 commit into
claude[bot] wants to merge 1 commit into
Conversation
…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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Archie McKenzie · Slack thread
Summary
Daily automated documentation scan. One subagent reviewed each subsection under
docs/en-US/plusblog/en-US,devlog/en-US, andauthors/againstCONTRIBUTING.mdandCLAUDE.md. Auto-generated files (docs-templates/and files carrying theAUTO-GENERATEDbanner) 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 namewithGTProps→withGTConfig; "vercel" → "Vercel".api/components/tx.mdx,api/strings/tx.mdx: garbled trade-off sentence cleaned up.api/strings/tx.mdx:getGTlink 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 alocaleCookieNameprop 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
CLAUDE.md's heading rule.authors
jackie.mdx: missingoccupationfield, 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 missingoccupation, but there's no single correct value for a placeholder team account, so it was left alone.How
scripts/validate-links.tsbefore and after — all links valid both times.<script>/<iframe>/etc.,javascript:URLs) were introduced.pnpm build:content— builds clean.