Skip to content

docs: convert in-site absolute links to root-relative#860

Merged
danielfsousa merged 2 commits into
mainfrom
docs/relative-links
Jul 14, 2026
Merged

docs: convert in-site absolute links to root-relative#860
danielfsousa merged 2 commits into
mainfrom
docs/relative-links

Conversation

@danielfsousa

@danielfsousa danielfsousa commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #858. That PR migrated in-site documentation links to the docs.sparkpost.com host but kept them as absolute URLs. These links point right back at this same site, so this PR converts them to root-relative paths:

https://docs.sparkpost.com/docs/.../docs/...

Why relative is better for in-site links:

Scope

  • 65 files, all under content/docs/.
  • Only https://docs.sparkpost.com/docs/... links were rewritten. External SparkPost links are left absolute:
    • developers.sparkpost.com/api/... (separate API reference site)
    • app.sparkpost.com/... (the app)
    • www.sparkpost.com/... (marketing/blog/pricing)
  • One bare auto-linked URL was upgraded to a proper [here](/docs/...) markdown link so it stays clickable.

Test plan

  • Spot-check a few updated links navigate correctly (client-side, no full reload)
  • Confirm external sparkpost.com links are unchanged

Note

Low Risk
Documentation-only link target changes with no application or API logic affected; risk is limited to broken internal links if any path was mistyped.

Overview
Follow-up to the docs host migration: this PR rewrites in-site markdown links from https://docs.sparkpost.com/docs/... to /docs/... across 65 files under content/docs/.

External SparkPost URLs (developers.sparkpost.com, app.sparkpost.com, www.sparkpost.com) are unchanged. One bare suppression-list URL was turned into a proper [here](/docs/...) link.

The goal is client-side navigation via next/link, correct behavior on preview/staging hosts, and alignment with existing root-relative link style in the content.

Reviewed by Cursor Bugbot for commit 511eca8. Bugbot is set up for automated code reviews on this repo. Configure here.

Convert internal doc links from https://docs.sparkpost.com/docs/... to
/docs/... (root-relative) across 65 files. This enables client-side
routing via next/link, keeps links correct on preview/staging deploys,
and matches the relative-link convention already used elsewhere in the
content. External sparkpost.com links (developers/app/www) are left
absolute.
@netlify

netlify Bot commented Jul 14, 2026

Copy link
Copy Markdown

Deploy Preview for support-docs ready!

Name Link
🔨 Latest commit 511eca8
🔍 Latest deploy log https://app.netlify.com/projects/support-docs/deploys/6a56621160c2dd0008775fd8
😎 Deploy Preview https://deploy-preview-860--support-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

/docs/product.url is a merge-field placeholder inside a fenced code
example, not a real navigational link. Keep it as-is to scope this PR
to genuine in-site links.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Want higher recall? High effort reviews run extra passes and find more bugs. A team admin can switch effort levels in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 511eca8. Configure here.

Comment thread content/docs/faq/post-to-webhook-target-failed.md
@danielfsousa danielfsousa self-assigned this Jul 14, 2026
@danielfsousa danielfsousa merged commit 04b895a into main Jul 14, 2026
5 of 7 checks passed
@danielfsousa danielfsousa deleted the docs/relative-links branch July 14, 2026 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants