Skip to content

Submit the sitemap and validate structured data in Search Console #4264

Description

@khajavi

Status: all code work is merged and deployed. Everything that can be checked automatically has been verified against production. What remains needs Google Search Console access, so this is a one-person task rather than a code change.

Remaining work

Both items need Search Console property access for ziohttp.com:

  • Verify ownership of ziohttp.com, then submit https://ziohttp.com/sitemap.xml under Indexing → Sitemaps
  • Request indexing of https://ziohttp.com/ via URL Inspection

Optional, and needs no Search Console account:

  • validator.schema.org on https://ziohttp.com/ — expect Organization, WebSite, SoftwareSourceCode and BreadcrumbList, no errors
  • Rich Results Test — expect Breadcrumbs detected. The other three are not rich-result types, so their absence is the correct outcome, not a failure

Worth checking a few days after submission: the Pages report for indexing coverage, and Enhancements → Breadcrumbs, where roughly 73 valid items are expected.

Verified in production

Check Result
robots.txt 200, advertises the sitemap, disallows /search
sitemap.xml 200, ~108 URLs, includes the category hub pages, excludes /blog and /markdown-page
/blog, /markdown-page 404
/examples/static-files 301 to /examples/serving-static-files
Entity graph Organization, WebSite, SoftwareSourceCode on 108 pages
Breadcrumbs BreadcrumbList on 106 pages; 73 carry a real trail (68 two-level, 5 three-level)
Duplicate titles 0
Duplicate descriptions 0
Generated config pages no leaked front matter; anchors and links resolve, zero unresolved

Contributing changes

PR Change
#4260 Name casing, unified description, canonical homepage, robots.txt, JSON-LD entity graph, sitemap metadata, template pages removed, generated config page fixes, doc link normalization
#4265 Category links so breadcrumbs form a full trail
#4266 onBrokenMarkdownLinks moved under markdown.hooks
#4267 Examples sidebar grouped; duplicated static files example removed
#4268 Duplicate titles and absent descriptions fixed

Known non-issues

  • 33 pages emit a single-element breadcrumb. These are root documents, category link targets, and the generated index pages themselves, all of which sit at the top of their own trail.
  • /search and /algolia have no meta description. The former is already noindex; the latter is a helper page.
  • lastmod is set on only one sitemap URL, so the lastmod: 'date' option is effectively inert. Docusaurus builds the mdoc output in website/docs, which is generated and gitignored, so the sitemap plugin has no git history to derive dates from. Harmless as it stands; making it work would require a custom sitemap step.

Not addressed

  • The Organization node describes ZIO at zio.dev as the site's publisher, so logo signals accrue to zio.dev rather than ziohttp.com. Correct modelling, but worth revisiting if a knowledge panel for ziohttp.com is wanted.
  • Eight guide titles exceed 60 characters and will be truncated in search results.

Metadata

Metadata

Assignees

No one assigned

    Labels

    maintenanceChore or Maintenance tasks

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions