Skip to content

Improve Help page titles and descriptions across 11 languages - #281

Merged
littleben merged 144 commits into
mainfrom
codex/docs-metadata-quality-20261021
Oct 21, 2026
Merged

littleben merged 144 commits into
mainfrom
codex/docs-metadata-quality-20261021

Conversation

@littleben

@littleben littleben commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Audit title and description metadata for all 1,884 current MDX pages across 11 locales; improve 1,142 pages where labels were ambiguous or summaries were vague, overloaded, outdated or incomplete.
  • Clarify page intent for AI features, imports, field types, views, API authentication, migration, automation and self-hosted administration.
  • Preserve every page body, link, route, non-editorial frontmatter property and existing sidebar label. Keep already specific metadata and documented noindex/archive policies.
  • Each page family is a separate commit with local rendered-HTML evidence. Include an additional isolated correction for three Asana descriptions identified in independent review.

Verification

  • 144 independent commits: 143 page families plus the isolated Asana summary correction.
  • 1,142 unique changed pages passed local HTTP/HTML checks; all 3 corrected Asana pages rechecked after the final change (1,145 total page checks).
  • Every changed page: exact HTML title, H1, description, Open Graph/Twitter title and description; existing native cards, content IDs and indexability checks passed.
  • 39 independent runtime samples across all 11 locales passed, including original short sidebar labels.
  • Source invariants: all page bodies byte-for-byte unchanged, other metadata and existing sidebar labels preserved; no duplicate locale titles.
  • SEO source checks: 1,884 current pages and 29 archive pages passed.
  • Existing test gates: Python 38/38, Node 15/15; final Mintlify build validation passed.
  • Independent source/editorial reviews cover all current MDX pages, with every requested correction resolved.

The local Mintlify preview remains available at http://localhost:3000/zh. Local preview canonical generation has the previously documented /src/_props limitation; this PR changes no canonical/redirect/indexing configuration and does not use local canonical output as production verification.

Editorial review

Three independent agents reviewed all 11 locales, cross-reviewed proposals and checked final source invariants. Findings were corrected, including unsupported sandbox/context wording, locale-specific condition descriptions, French elision, Turkish suffixes and single-value terminology.

Follow-up content work

Track separately: generated OpenAPI operation summaries, Excel comparison accuracy, security certification statements, legacy one-click guide structure, model example IDs and existing locale body-copy errors. This PR does not broaden any of those product claims.

Final CI

  • Exact head 2aaed48c6e15d5a0d594b4ddce2706a749feff47: Docs SEO workflow succeeded, including build and broken-link/anchor/redirect checks.
  • Changelog order and CLA checks passed. PR remains open for review; production deployment is not part of this PR-stage result.

@littleben
littleben merged commit f4af8d5 into main Oct 21, 2026
5 checks passed
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.

1 participant