fix: daily docs scan — CI hard-fails, broken prop names, style fixes - #398
Open
claude[bot] wants to merge 1 commit into
Open
fix: daily docs scan — CI hard-fails, broken prop names, style fixes#398claude[bot] wants to merge 1 commit into
claude[bot] wants to merge 1 commit into
Conversation
- Remove bare `import Video` statements in 3 devlog entries and 1 blog post (CI hard-fails on import/export in MDX body) - Fix wrong `context` prop -> `$context` in the Next.js quickstart troubleshooting section, and `GT_API_KEY` -> `GT_DEV_API_KEY` in two Next.js quickstart dev-setup snippets, to match the documented config/credentials reference - Fix a mismatched cross-reference in the React Core linter rules page (getGT link pointed at the Node SDK instead of the Next.js function) - Add missing `occupation` frontmatter field on two author profiles; fix a malformed twitter URL on another - Add missing code-fence language tags, fix link punctuation, drop a leftover placeholder anchor and an editorial JSX comment, and other small grammar/formatting fixes across docs, blog, and devlog content
Contributor
Author
|
Automation note (daily-content-docs-scan):
A push notification was sent to the account owner flagging both issues. This PR is otherwise ready for manual review/merge. |
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
Daily automated scan for documentation-quality issues across
docs/en-US/,blog/en-US/,devlog/en-US/, andauthors/. 18 subagents scanned every subsection in parallel; only high-confidence, mechanical fixes were applied.Before/After summary
Authors
authors/jackie.mdx,authors/default.mdx: Before: missing the requiredoccupationfrontmatter field. After: added (Software Engineer,Team).authors/archie.mdx: Before:twitterURL had a stray/photosuffix. After: cleaned to the plain profile URL.Blog (
blog/en-US/)i18n-without-translation-files.mdx: Before: a bareimport Video from '@/components/Video'statement in the MDX body — a CI hard-fail. After: removed (the<Video>component is globally available, no import needed).gt-next.mdx: Before: two fenced code blocks missing a language id (``` copyand```.env copy). After: taggedbashandenv.ai-chatbot.mdx: Before:## Deploying to Productionused Title Case, inconsistent with every other heading in the file. After: sentence case.multilingual-nextjs-seo.mdx: Before: two untagged code fences, plus a leftover editorial JSX comment left in published prose. After: fences taggedtext; comment removed.plurals.mdx: Before: four untagged code fences. After: taggedtext.Devlog (
devlog/en-US/)gt-react_v10_15_0.mdx,gt-react_v10_19_0.mdx,react-core-linter_v0_1_0.mdx: Before: bareimport Video from '@/components/Video'statements in the MDX body — CI hard-fails. After: removed; the<Video>usages that follow are unaffected since the component is globally available.gt-i18n_v0_1_0.mdx: Before:msg(),mFallback(),gtFallback()linked to placeholder(#)anchors. After: de-linked to plain inline code since no reference page exists yet for this package.gt-next_v6_3_0.mdx,gt-react_v10_18_0.mdx: Before: untagged code fences. After: taggedtext.Docs — CLI
cli/quickstart.mdx: Before: no blank line between the## Quickstartheading and its lead-in paragraph. After: blank line added.Docs — Python
python/reference/functions/extract-variables.mdx: Before: frontmatter description opened with the abbreviation "GT" instead of spelling out the product name on first mention. After: "General Translation".Docs — React
react/guides/configuring.mdx: Before: frontmatter missing the required blank line before the closing---. After: added.react/nextjs-quickstart.mdx: Before: dev-setup.env.localsnippet set the development key intoGT_API_KEY(per the Next.js config reference, that variable is production-only); the troubleshooting section used acontextprop and code example that doesn't match the library's actual$contextprop, plus a "Both X, Y, and Z" grammar slip. After: env var corrected toGT_DEV_API_KEY; prop corrected to$contextin prose and code; grammar fixed.react/nextjs-pages-router-quickstart.mdx: Before: sameGT_API_KEY/GT_DEV_API_KEYmismatch in its dev-setup snippet. After: corrected.react/reference/lint-rules.mdx: Before: thegetGTlink in the rules table pointed at the Node SDK'sgetGT, but the React Core linter's default libs aregt-react/gt-next/gt-react-native, notgt-node. After: repointed to the Next.jsgetGTreference page, matching how this function is linked elsewhere in the same doc set.Docs — Platform / Core
platform/core/quickstart.mdx: Before: frontmatter description wrappedgeneraltranslationin backticks (backticks render literally in meta descriptions/llms.txt). After: backticks removed.platform/core/guides/translating-files.mdx: Before: an ungrammatical intro sentence mixing verbs and a noun ("upload, enqueue, status, and download workflows for files"). After: reworded to parse correctly.platform/core/reference/gt-class/constructor.mdx: Before: "enterprise deployments" lowercase in two spots, inconsistent with the canonical casing used on the sibling types reference page. After: capitalized to "Enterprise".Docs — Platform / Dashboard
platform/dashboard/reference/project-settings.mdx: Before: frontmatter missing the required blank lines after the opening and before the closing---. After: added.platform/dashboard/guides/adding-translation-context.mdx: Before: lowercase German formal "sie" (should always be capitalized as "Sie"); a singular/plural article mismatch ("fill an empty Glossary and Directive fields"). After: both fixed.Docs — Platform / Locadex
platform/locadex/guides/configuring-workflows.mdx: Before: a stray space before a period, and link punctuation placed inside the brackets. After: both fixed.platform/locadex/guides/managing-languages.mdx: Before: link punctuation inside the brackets. After: moved outside, per the docs style guide.platform/locadex/guides/auto-merging-prs.mdx: Before: a comma splice joining two independent clauses inside a parenthetical. After: split with a semicolon and closed the sentence properly.Docs — Integrations
integrations/mintlify/guides/managing-translations.mdx: Before: trailing space in the frontmattertitle. After: removed.How
29 targeted edits across 29 files (docs, blog, devlog, authors). No prose was rewritten for voice/tone, no code semantics were changed, and
docs-templates/was left untouched. A handful of additional findings (frontmatter schema nitpicks, a stacked-callout cleanup) were surfaced by the scan but held back as medium-confidence rather than applied.Generated by Claude Code