Fix docs canonical domain (www) + probe trailing-slash override#420
Merged
Conversation
Add seo.metatags.canonical so Mintlify emits canonical URLs on the www apex. Live pages currently emit `https://checklyhq.com/docs/...` (bare domain), which 301s to www — a non-self-referential canonical. This fixes the domain for every docs page in one line. Note: Mintlify appends each page's path without a trailing slash, so the canonical becomes www + no-slash (still a single 308 to the served trailing-slash URL). The trailing-slash question is probed separately. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Temporary probe: verify whether Mintlify emits a per-page `canonical` override verbatim (including the trailing slash) or normalizes it to no-slash. On the preview deploy, inspect the rendered <link rel="canonical"> for /docs/cli/overview/ — if it keeps the slash, we can script this across all pages; if stripped, drop this commit. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
What
Two SEO/canonical changes for the docs, following the P4 trailing-slash investigation.
1. Global canonical domain fix (
docs.json) — the real changeAdds
seo.metatags.canonical: "https://www.checklyhq.com". Live docs pages currently emit<link rel="canonical" href="https://checklyhq.com/docs/...">— bare domain, which 301s to www, so the canonical is non-self-referential. This sets the canonical base to the www apex for every page in one line (Mintlify appends each page's path).2. Trailing-slash probe (
cli/overview.mdx) — temporary, review-onlyMintlify appends paths without a trailing slash, and has no global
trailingSlashoption, so the canonical will bewww+ no-slash (a single 308 to the served.../overview/). This commit adds a per-pagecanonical:frontmatter with an explicit trailing slash to test whether Mintlify emits it verbatim or normalizes it away.How to verify on the preview deploy
Once the Mintlify preview builds, check the rendered
<link rel="canonical">:/docs/detect/overview/) → should now behttps://www.checklyhq.com/...(www, not bare). ✅ confirms the global fix./docs/cli/overview/→ does the tag show a trailing slash (.../cli/overview/) or not?www+ no-slash (Google already indexes the slash form regardless).Merge guidance
docs.json) is safe to keep regardless.cli/overview.mdx) is a probe — keep only if the slash survives and we choose to pursue per-page canonicals; otherwise drop it before merge.🤖 Generated with Claude Code