⚡ Bolt: canonicalize documentation links and fix broken references#32
⚡ Bolt: canonicalize documentation links and fix broken references#32soktri3 wants to merge 1 commit into
Conversation
This change optimizes the repository's documentation by replacing redirected or broken links with their canonical destinations. This reduces network latency for developers navigating the documentation and ensures a smoother onboarding experience. Key improvements: - Canonicalized Model Context Protocol specification links to avoid domain redirects. - Fixed broken HackerOne submission and program links in SECURITY.md. - Updated specification repository references in CONTRIBUTING.md. - Added trailing slashes to Contributor Covenant links to eliminate 301 redirects. - Updated Mozilla diversity links to the current inclusion endpoint. - Ensured consistency across root and profile documentation files. Co-authored-by: soktri3 <170663878+soktri3@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
There was a problem hiding this comment.
Code Review
This pull request updates several documentation files to canonicalize URLs, update repository references, and point to the new specification location. The feedback provided suggests adding trailing slashes to specific URLs in SECURITY.md and profile/README.md to maintain consistency with other changes and prevent unnecessary redirects.
| ## Vulnerability Disclosure Program | ||
|
|
||
| Our Vulnerability Program Guidelines are defined on our [HackerOne program page](https://hackerone.com/anthropic-vdp). | ||
| Our Vulnerability Program Guidelines are defined on our [HackerOne program page](https://hackerone.com/anthropic). |
There was a problem hiding this comment.
For consistency with the canonicalization goal of this PR and to avoid a potential redirect, consider adding a trailing slash to the HackerOne program page URL.
| Our Vulnerability Program Guidelines are defined on our [HackerOne program page](https://hackerone.com/anthropic). | |
| Our Vulnerability Program Guidelines are defined on our [HackerOne program page](https://hackerone.com/anthropic/). |
| <p align="center"> | ||
| <a href="https://modelcontextprotocol.io/docs/getting-started/intro">Documentation</a> | | ||
| <a href="https://spec.modelcontextprotocol.io">Specification</a> | | ||
| <a href="https://modelcontextprotocol.io/specification">Specification</a> | |
There was a problem hiding this comment.
To align with the canonicalization of other links in this PR (like the Contributor Covenant URLs), consider adding a trailing slash to the specification URL to ensure it points directly to the final target.
| <a href="https://modelcontextprotocol.io/specification">Specification</a> | | |
| <a href="https://modelcontextprotocol.io/specification/">Specification</a> | |
|
|
||
| - 📚 Read the [Documentation](https://modelcontextprotocol.io/docs/getting-started/intro) for guides and tutorials | ||
| - 🔍 Review the [Specification](https://spec.modelcontextprotocol.io) for protocol details | ||
| - 🔍 Review the [Specification](https://modelcontextprotocol.io/specification) for protocol details |
There was a problem hiding this comment.
Adding a trailing slash here will maintain consistency with the canonicalization improvements made elsewhere in the documentation.
| - 🔍 Review the [Specification](https://modelcontextprotocol.io/specification) for protocol details | |
| - 🔍 Review the [Specification](https://modelcontextprotocol.io/specification/) for protocol details |
⚡ Bolt: canonicalize documentation links and fix broken references
💡 What: Audited and updated URLs in
README.md,CONTRIBUTING.md,CODE_OF_CONDUCT.md, andSECURITY.mdto use canonical, non-redirecting targets.🎯 Why: Every HTTP redirect (301/302) adds a network round-trip (RTT) which can delay page loads by 50-400ms depending on the user's connection. Using canonical URLs improves navigation speed and prevents issues with broken or old references (like the HackerOne VDP endpoint).
📊 Impact:
🔬 Measurement: Verified using
curl -s -o /dev/null -w "%{http_code} -> %{redirect_url}\n"to ensure updated links return200 OKor point to the final intended destination without intermediate hops.PR created automatically by Jules for task 2614378922628679614 started by @soktri3