Skip to content

docs: daily quality scan fixes (2026-07-17)#374

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

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

Conversation

@claude

@claude claude Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Requested by Archie McKenzie · Slack thread

Summary

Daily automated docs-quality scan of docs/en-US, blog/en-US, devlog/en-US, and authors/ against CONTRIBUTING.md. Fixes are conservative: CI hard-fails, broken links, malformed code fences, and clear typos only — no voice/style rewrites, no code-semantics changes.

Blog (blog/en-US)

  • Before: Two posts (i18n-without-translation-files.mdx, and separately in devlog) used a bare import Video from '@/components/Video' + <Video> component — imports are a CI hard-fail. After: import removed, replaced with a plain markdown link to the video asset.
  • Before: gt-next.mdx had a code fence with no language id and jumped from the (implicit) H1 straight to an H3 heading, skipping H2. After: fence tagged bash, headings promoted to the correct H2/H3 levels.
  • Before: Several bare, language-less code fences in multilingual-nextjs-seo.mdx and plurals.mdx. After: tagged text.
  • Before: best-localization-software.mdx linked /docs/locadex (doesn't exist) and /docs/next/quickstart (no such section). After: corrected to /docs/platform/locadex and /docs/react/nextjs-quickstart.
  • Before: nextjs-i18n-code-is-the-source-of-truth.mdx had five broken doc links (renamed guide slugs, wrong CLI/Next.js paths, a nonexistent guide). After: corrected to the real pages; the one link with no confirmed replacement was unlinked rather than left broken.
  • Before: branch_vs_ternary.mdx had a garbled anecdote ("translating 'crop' to 'crop'"). After: clarified to state the actual mix-up (the agricultural sense of "crop" instead of the image-editing sense).

Devlog (devlog/en-US)

  • Before: Three entries used the same blocked import Video + <Video> pattern. After: same fix as above (plain link).
  • Before: gt-i18n_v0_1_0.mdx had three list items linking to a bare # (empty/placeholder anchor). After: unlinked to plain inline code.
  • Before: Two bare code fences (gt-next_v6_3_0.mdx, gt-react_v10_18_0.mdx). After: tagged text.

Docs (docs/en-US)

  • react/nextjs-quickstart.mdx: the FAQ example used context instead of the real $context prop — now matches the <T> reference and every other quickstart.
  • platform/core/guides: fixed a broken parallel-structure sentence in translating-files.mdx, and an acronym typo ("Best Current Practices" → "Best Current Practice" for BCP) in locale-codes.mdx.
  • platform/core/reference/gt-class/constructor.mdx: a customMapping example mapped en-US to the name "Mandarin" and a French flag emoji — replaced with a coherent zh → Mandarin/🇨🇳 example.
  • platform/dashboard/guides: fixed a missing article + inconsistent "buildtime"/"build-time" wording in managing-billing.mdx; fixed an uncapitalized German formal pronoun ("sie" → "Sie") and a singular/plural mismatch in adding-translation-context.mdx.
  • platform/locadex/guides: fixed link punctuation (period was inside the link brackets instead of after) in two guides.
  • overview: added a missing trailing period to a frontmatter description; fixed a subject-verb agreement typo in the embedded AGENTS.md template on the "For coding agents" page.

Authors (authors/)

  • Added the missing required occupation field to two author profiles (jackie.mdx, default.mdx).
  • Fixed a malformed Twitter URL on archie.mdx that pointed to a specific tweet's photo view instead of the profile.

How

26 files touched, all .mdx content edits — no code, config, or build changes. Full list: authors/{archie,default,jackie}.mdx; blog/en-US/{best-localization-software,branch_vs_ternary,gt-next,i18n-without-translation-files,multilingual-nextjs-seo,nextjs-i18n-code-is-the-source-of-truth,plurals}.mdx; devlog/en-US/{gt-i18n_v0_1_0,gt-next_v6_3_0,gt-react_v10_15_0,gt-react_v10_18_0,gt-react_v10_19_0,react-core-linter_v0_1_0}.mdx; docs/en-US/overview/{for-coding-agents,key-concepts}.mdx; docs/en-US/platform/core/guides/{locale-codes,translating-files}.mdx; docs/en-US/platform/core/reference/gt-class/constructor.mdx; docs/en-US/platform/dashboard/guides/{adding-translation-context,managing-billing}.mdx; docs/en-US/platform/locadex/guides/{configuring-workflows,managing-languages}.mdx; docs/en-US/react/nextjs-quickstart.mdx.


Generated by Claude Code

- Remove bare `import Video`/`<Video>` MDX components (CI hard-fail: import
  statements are blocked) in blog and devlog posts; replace with plain links
  to the video asset.
- Fix broken internal/external doc links across blog posts (renamed guide
  slugs, wrong section paths, /docs/locadex, nextjs quickstart path).
- Add missing language ids to bare fenced code blocks (blog, devlog).
- Fix a skipped heading level (H3 before any H2) in a blog post.
- Fix incorrect `context` prop name (should be `$context`) in the Next.js
  quickstart, to match the `<T>` reference and other quickstarts.
- Fix grammar/typos: parallel structure, BCP 47 wording, missing article,
  German pronoun capitalization, subject-verb agreement, singular/plural
  mismatch, garbled WhatsApp anecdote, nonsensical example locale mapping.
- Fix link-punctuation placement (period inside vs. outside brackets) in
  two Locadex guides.
- Fill in missing `occupation` frontmatter field on two author profiles,
  and fix a malformed twitter URL on a third.
- Add trailing period to a frontmatter description missing it.

Found via a subagent-per-subsection scan of docs/en-US, blog/en-US,
devlog/en-US, and authors/ against CONTRIBUTING.md conventions.
@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