Fix broken & stale internal links from Ahrefs site audit (P0 + P1)#417
Merged
Conversation
P0 — repair 6 broken (404) internal links caused by relative-path resolution and one stray auto-linked URL: - api-checks openapi-spec & quickstart: `](assertions)` -> `/detect/assertions` - managing-false-positives: `](./network-diagnostic-tools)` -> `/platform/network-diagnostic-tools` - constructs/multistep-check: `](platform/runtimes/runtime-specification)` -> absolute path - end-to-end-monitoring: backtick example URL that had a stray curly apostrophe (’ -> 404) P1 — repoint ~120 stale links that targeted pre-migration paths and only resolved via redirects, and convert absolute www.checklyhq.com/docs URLs to relative internal links (per docs conventions). Legacy sections remapped: /cli, /browser-checks, /monitoring, /api-checks, /alerting(+-and-retries), /cicd, /status-pages, /traces-open-telemetry, /runtimes, /groups, /analytics, /testing, /heartbeat-monitors, /tcp-monitors, and /integrations/{pagerduty,rootly,opsgenie,pulumi}. Two tutorial example URLs inside code blocks (page.goto to /docs/browser-checks/) are intentionally left as-is; their prose counterparts were backticked. Verified with `mint broken-links`: no broken links found. 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 & why
Remediates the P0 (errors) and P1 (stale migration links) findings from the Ahrefs Site Audit of
www.checklyhq.com/docs/(health 99, but a large redirect/broken-link tail). Every internal link was verified withmint broken-links(no broken links found).P0 — 6 broken (404) links fixed
All were relative-path resolution bugs (a link without a leading
/resolves relative to the current page) plus one stray auto-linked URL:detect/.../api-checks/openapi-spec.mdx](assertions)/detect/assertionsdetect/.../api-checks/quickstart.mdx](assertions)/detect/assertionsplatform/managing-false-positives.mdx](./network-diagnostic-tools)/platform/network-diagnostic-toolsconstructs/multistep-check.mdx](platform/runtimes/runtime-specification)/platform/runtimes/runtime-specificationguides/end-to-end-monitoring.mdx’→%E2%80%99404guides/claude-code-monitoring.mdx/ai//use-checkly-with-ai-ide/#claude-code(double slash + retired slug)/ai/overviewP1 — ~120 stale links repointed
These targeted pre-migration paths and only resolved via redirects (extra hops, crawl waste). Also converts absolute
https://www.checklyhq.com/docs/...URLs to relative internal links per the docs conventions. Applied deterministically with path-boundary-safe old→new pairs; bogus auto-generated anchors (…---checkly-docs) and retired-slug anchors were dropped.Legacy sections remapped include:
/cli→/cli/overview,/browser-checks/*→/detect/synthetic-monitoring/browser-checks/*,/monitoring/*→/detect/...&/concepts/*,/api-checks/*→/detect/...&/platform/*,/alerting(-and-retries)→/communicate/alerts/overview,/cicd/*→/integrations/ci-cd/*,/status-pages→/communicate/status-pages/overview,/traces-open-telemetry/*→/resolve/traces/*,/runtimes*→/platform/runtimes/*,/groups→/platform/groups,/analytics→/platform/reporting/analytics-api,/integrations/{pagerduty,rootly,opsgenie,pulumi}→ new locations.Notes for reviewers
page.goto('…/docs/browser-checks/')) are intentionally left as-is — they're illustrative navigation targets, not doc links. Their prose counterparts were backticked.constructs-reference#…anchors now land on/constructs/overview(matching the live redirect). Pointing them at the specific per-construct pages is a reasonable follow-up content refinement.Out of scope (tracked separately)
descriptionfrontmatter (mostly/learn/playwright).<title>s, theauthentication.mdxmultiple-H1, meta-description length polish.trailingSlash: truein the marketing repo'snext.config.js(the/docsreverse-proxy), not this repo — plus a canonical-tag mismatch worth a web-team ticket.🤖 Generated with Claude Code