Daily docs scan: fix CI hard-fails, typos, and heading issues#353
Closed
claude[bot] wants to merge 1 commit into
Closed
Daily docs scan: fix CI hard-fails, typos, and heading issues#353claude[bot] wants to merge 1 commit into
claude[bot] wants to merge 1 commit into
Conversation
- Remove live import statements in MDX (CI hard-fail) in core/index, react-core-linter/index, react-core-linter/guides/quickstart - Fix skipped heading levels in core/locales.mdx and locadex guides - Fix grammar/typos in core/quickstart, next/tx docs, overview, python/strings, react & react-native gtprovider docs - Fix incorrect example output in core determine-locale docs - Fix mis-numbered list in next/guides/migration - Add missing OpenAPI operation descriptions (root cause of blank frontmatter description on 6 generated api/*.mdx pages)
Contributor
Author
|
Daily docs scan summary (posted here because Slack delivery to C0AEUCELSUT failed this run — session's Slack tools were unavailable) Issues found → fixed, by subsection:
18 files changed total. Verified with Lower-confidence issues left untouched for human review are listed in the PR description above. Auto-merge: could not be enabled via API in this environment (GraphQL restricted to a pinned set of PR-review operations; no REST equivalent exists for |
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
Automated daily scan of
docs/en-US/*for CONTRIBUTING.md compliance, CI hard-fails, typos, and markdown issues. High-confidence fixes only — 18 files touched.Before / After by subsection
core
core/index.mdxhad a liveimport Video from '@/components/Video'statement in MDX — a CI hard-fail (Video is already globally registered, so it rendered fine but would fail the import/export lint). After: import removed.core/locales.mdxskipped from the implicit h1 title straight to h3 sub-headings. After: promoted to h2 to match the rest of the docs.core/quickstart.mdxhad a missing "and" ("...page clickCreate API Key"), a duplicated-phrase typo ("check the enqueue the file"), and a mis-used####heading inside a<Callout>. After: grammar fixed, heading converted to bold lead-in text.core/class/methods/locales/determine-locale.mdxandcore/functions/locales/determine-locale.mdxexample comments said preference['fr-CA', 'es-MX', ...]resolves to'es-ES'. After: corrected to'fr-FR'(first-preference language match, consistent with the method's documented behavior).core/class/methods/formatting/format-date-time.mdxhad a dangling empty## Next stepsheading. After: removed.next
next/api/components/tx.mdxandnext/api/strings/tx.mdxhad a garbled sentence ("...delay while waiting for an on-demand translation to load is significantly slower"). After: added "which" for correct grammar.next/guides/migration.mdxhad a mis-numbered list (two "2." items). After: renumbered to "3."react / react-native
gtprovider.mdxAPI pages had a subject-verb agreement error ("Render settings controls..."). After: "control".locadex
locadex/mintlify.mdxandlocadex/next.mdxskipped from the page title straight to h3 step headings, andmintlify.mdxhad two more orphaned h3 sections. After: added a## Installationheading and promoted the orphaned sections to h2.react-core-linter
react-core-linter/index.mdxandreact-core-linter/guides/quickstart.mdxhad liveimport Video from '@/components/Video'statements — a CI hard-fail. After: imports removed (component is globally registered).overview
overview/index.mdxhad a brand-name typo, "Clickhouse". After: corrected to "ClickHouse".python
python/guides/strings.mdxreferred to thecontextkwarg as$contextin prose/heading, inconsistent with the code example just below. After: corrected tocontext.api
api/*.mdxreference pages (getBranchInfo,getContextStatus,shouldGenerateContext,getTranslationStatus,getJobsInfo,getProjectInfo) were missing a frontmatterdescription, because their corresponding operations indocs/en-US/api/openapi.yamlhad asummarybut nodescription. Added the missingdescriptionfield to each of those 6 operations in the spec so the next Fumadocs generation run picks them up correctly. The generated.mdxfiles themselves were left untouched per their own "do not edit directly" notice.Not fixed (flagged for human review, left untouched — low confidence or needs a content-owner call)
python/guides/strings.mdx: possible kwarg-name mismatch (context=vs_context) between a guide and the API reference — couldn't confirm which is correct from docs alone.python/guides/strings.mdx:msg()links point to a page that doesn't documentmsg().react/react-nativegtprovider.mdx: "Learn more [here]" links to the same page (likely copy-paste artifact).react-native/api/helpers/get-locale-from-native-store.mdx: references alocaleCookieNameprop not present in theGTProviderprops reference.sanity:plugin-config.mdxandguides/configuration.mdxgive contradictory descriptions ofsingletonMapping's default behavior.locadex/auto-merge.mdx: an image alt-text string has an oddly placed quote.core/locales.mdx: one sentence ("However, the platform will only translate") is truncated mid-thought.core/class/methods/translation/check-job-status.mdx: "Notes" bullets read as copied from a different method's docs.core/class/constructor.mdx: a custom-locale-mapping example mapsen-USto a Mandarin name/French flag (likely a copy-paste mistake, correct values unknown).next/tutorials/dictionary/setup.mdx: page body is just a "under construction" placeholder (content gap, not a lint issue).How
18 files touched across
core,next,react,react-native,locadex,react-core-linter,overview,python, andapi(spec only). Verified with the repo's ownscripts/validate-links.ts(all 437 content files, zero broken links) and a YAML syntax check onopenapi.yaml.Generated by Claude Code