Fix docs home canonical + add home to sitemap#433
Merged
Conversation
The root index.mdx (served at /docs/) is not a docs.json nav page, so the per-page canonical rollout skipped it and it fell back to the global base — emitting <link rel="canonical" href="https://www.checklyhq.com/docs"> (no trailing slash), which mismatches the served /docs/ URL ("canonicalised away"). - index.mdx: add canonical 'https://www.checklyhq.com/docs/' (self-referencing). - generate-sitemap.mjs: include the home (BASE) URL — it was missing from the sitemap because it isn't a nav slug. Now 570 URLs. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Sweep for .mdx pages Mintlify serves that aren't in docs.json navigation — they were skipped by the canonical rollout and fell back to the global no-slash base (same bug as the home). 34 served orphans (best-practices, examples, *-configuration, section overviews, changelog, etc.) now declare a self-referencing trailing-slash canonical. The one hidden page (tcp-monitors/use-cases, hidden: true) is intentionally skipped. Not added to the sitemap (kept to nav pages + home); these are secondary pages reachable via links/redirects, not primary nav entries. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
The docs home (
index.mdx, served at/docs/) was the one page missed by the canonical rollout, because it is not adocs.jsonnav entry — so it fell back to the global base and emitted<link rel=\"canonical\" href=\"https://www.checklyhq.com/docs\">(no trailing slash), mismatching the served/docs/URL. An SEO extension flagged it as "canonicalised away / not indexable."Fixes
index.mdx: addcanonical: 'https://www.checklyhq.com/docs/'(self-referencing)..github/scripts/generate-sitemap.mjs: include the home URL (/docs/) — it was absent from the sitemap since it is not a nav slug. Sitemap is now 570 URLs.Notes
X-Robots-Tag: noindexan extension may show on the home is NOT present on the live www response (verified: no robots header onwww.checklyhq.com/docs/or the bare-domain 301). That reading is stale/preview; the real issue was only the canonical mismatch, which this fixes./docs/.🤖 Generated with Claude Code