Skip to content

Daily docs scan: fix CI hard-fails, frontmatter gaps, and prose bugs (2026-07-07)#346

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

Daily docs scan: fix CI hard-fails, frontmatter gaps, and prose bugs (2026-07-07)#346
claude[bot] wants to merge 1 commit into
mainfrom
docs/daily-scan-2026-07-07

Conversation

@claude

@claude claude Bot commented Jul 7, 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/. All changes below are conservative, high-confidence fixes only — no prose was rewritten for voice/style, no code semantics were changed beyond correcting a factual API-name mismatch, and docs-templates/ was left untouched.

CI-breaking constructs (would fail the build if left in place)

  • core, react-core-linter, blog, devlog (7 files): Removed a stray import Video from '@/components/Video'; line. import/export statements in MDX bodies are a hard CI failure per CONTRIBUTING.md. Verified <Video> renders correctly elsewhere in the repo (e.g. docs/en-US/locadex/mintlify.mdx) with no import at all, so the component is provided globally and the import was always dead/dangerous weight.
    • Before: page body contained import Video from '@/components/Video';
    • After: line removed, <Video> usage unchanged

Frontmatter

  • authors: default.mdx and jackie.mdx were missing the required occupation field — added (General Translation Team, Software Engineer, the latter matching the bio text already on the page).
  • authors/archie.mdx: twitter URL had a stray /photo suffix (.../archiemckenzie_/photo) not present on any other author profile — fixed to point at the profile.

Formatting

  • blog/en-US, devlog/en-US (9 code fences across gt-next.mdx, multilingual-nextjs-seo.mdx, plurals.mdx, gt-next_v6_3_0.mdx, gt-react_v10_18_0.mdx): Fenced code blocks were missing a language id, required by CONTRIBUTING.md. Added bash/text as appropriate.

Prose / correctness

  • docs/en-US/python/guides/strings.mdx: The "disambiguation" section's heading, prose, and 6 code samples all used context=, but the actual documented Python API (docs/en-US/python/api/t.mdx) uses _context=. Fixed all 6 occurrences to match the real API so the example code doesn't silently no-op for readers who copy-paste it.
  • docs/en-US/core/quickstart.mdx: Fixed a duplicated-word/garbled sentence ("later check the enqueue the file" → "later enqueue the file").
  • docs/en-US/next/api/strings/tx.mdx and docs/en-US/next/api/components/tx.mdx: Both pages had the identical malformed sentence "there is a delay while waiting for an on-demand translation to load is significantly slower" — fixed the dangling clause on both.
  • docs/en-US/key-concepts/dynamic-content.mdx: Fixed an inline code span that was broken by unnecessary backslash-escaping (rendered literal backslashes instead of a clean code snippet).
  • docs/en-US/core/class/methods/formatting/format-date-time.mdx: Removed an empty trailing ## Next steps heading with no content beneath it (every sibling reference page either omits this heading or fills it in).
  • docs/en-US/cli/reference/config.mdx: The "Per-file publish control" section listed po as a supported file-type key, but the same file's own "Supported file types" list defines the key as pot — fixed to match.

Flagged but intentionally NOT fixed in this PR

  • 6 files under docs/en-US/api/** are missing a description frontmatter field, but those files are auto-generated by Fumadocs from an OpenAPI spec and carry an explicit "Do not edit this file directly" notice — a manual edit would just be clobbered on the next regeneration. This needs to be fixed upstream in the OpenAPI operation descriptions instead.
  • docs/en-US/core/locales.mdx has a sentence that trails off mid-thought ("However, the platform will only translate") — flagging for a human writer since completing it correctly requires product knowledge I don't have.
  • docs/en-US/cli/download.mdx's --force vs --force-download flag descriptions are ambiguous relative to translate.mdx, but resolving it requires confirming actual CLI behavior — left for a maintainer.

How

22 files touched across authors/, blog/en-US/, devlog/en-US/, and docs/en-US/{core,cli,key-concepts,next,python,react-core-linter}/. No files in docs-templates/ were touched.

Daily automated docs-quality scan across docs/en-US, blog/en-US,
devlog/en-US, and authors/:

- Remove stray `import Video from '@/components/Video'` statements in
  7 files (CI hard-fails MDX import/export statements; Video renders
  fine elsewhere without an explicit import)
- Add missing `occupation` frontmatter field to 2 author profiles and
  fix a malformed twitter URL
- Add language ids to 9 bare fenced code blocks in blog/devlog posts
- Fix `context=` -> `_context=` in Python string guide code samples to
  match the documented `t()`/`msg()` API
- Fix a duplicated-word/garbled sentence in the core quickstart guide
  and an identical malformed sentence duplicated across both `tx`
  reference pages
- Fix broken escaped-backtick code span in the dynamic-content guide
- Remove an empty trailing "Next steps" heading with no content
- Fix `po` -> `pot` file-type key in the CLI config reference to match
  the file type documented earlier on the same page
@claude
claude Bot requested a review from a team as a code owner July 7, 2026 15:20
@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