Skip to content

Improve documentation discovery and search metadata #67

Description

@davidalucas

The documentation site has crawlable static HTML, but search discovery and page identification need improvement. Operation titles repeat across client languages, several overview breadcrumbs point at trailing-slash URLs that return 404, and the internal search page is included in the sitemap.

Scope and Acceptance Criteria

  • Improve homepage and language overview titles, descriptions, and introductory copy without changing API or availability claims.
  • Distinguish API search titles by language while preserving exact MP labels, headings, navigation, and command anchors.
  • Correct breadcrumb URLs to match canonical routes.
  • Mark the internal search page noindex and omit it from the sitemap in the search-enabled build.
  • Add factual homepage WebSite identity and a branded social preview using existing assets.
  • Add focused rendered-HTML checks; npm ci and npm run check must pass on Node.js 24.
  • Document Search Console submission and verification. Establish discovery links from public project repositories; small associated PRs may reference this issue.

Sitemap submission and key URL inspection are operational follow-up. Google controls indexing and ranking timing. Preserve the existing catalog hierarchy and per-target support claims.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions