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
Closed
Daily docs scan: fix CI hard-fails, frontmatter gaps, and prose bugs (2026-07-07)#346claude[bot] wants to merge 1 commit into
claude[bot] wants to merge 1 commit into
Conversation
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
Contributor
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 docs-quality scan of
docs/en-US,blog/en-US,devlog/en-US, andauthors/. 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, anddocs-templates/was left untouched.CI-breaking constructs (would fail the build if left in place)
import Video from '@/components/Video';line.import/exportstatements in MDX bodies are a hard CI failure perCONTRIBUTING.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.import Video from '@/components/Video';<Video>usage unchangedFrontmatter
default.mdxandjackie.mdxwere missing the requiredoccupationfield — added (General Translation Team,Software Engineer, the latter matching the bio text already on the page).twitterURL had a stray/photosuffix (.../archiemckenzie_/photo) not present on any other author profile — fixed to point at the profile.Formatting
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 byCONTRIBUTING.md. Addedbash/textas appropriate.Prose / correctness
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.## Next stepsheading with no content beneath it (every sibling reference page either omits this heading or fills it in).poas a supported file-type key, but the same file's own "Supported file types" list defines the key aspot— fixed to match.Flagged but intentionally NOT fixed in this PR
docs/en-US/api/**are missing adescriptionfrontmatter 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.mdxhas 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--forcevs--force-downloadflag descriptions are ambiguous relative totranslate.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/, anddocs/en-US/{core,cli,key-concepts,next,python,react-core-linter}/. No files indocs-templates/were touched.