⚡ Bolt: canonicalize documentation links and fix broken URLs#33
Conversation
This change optimizes the user experience by replacing redirected URLs with their canonical counterparts and fixing broken security reporting links. 💡 What: - Updated `CODE_OF_CONDUCT.md` and `profile/CODE_OF_CONDUCT.md` with canonical Contributor Covenant and Mozilla links. - Fixed broken HackerOne links in `SECURITY.md`. - Replaced unreliable/redirected `spec.modelcontextprotocol.io` with canonical `modelcontextprotocol.io/specification` in `profile/README.md`. - Updated specification repository links to reflect the rename to `modelcontextprotocol`. 🎯 Why: - Non-canonical URLs trigger HTTP redirects, adding unnecessary network round-trips (latency). - Broken links in `SECURITY.md` prevent security researchers from reporting vulnerabilities through the intended channel. - The `spec.` subdomain was observed to be unreliable (connectivity timeouts). 📊 Impact: - Reduces navigation latency by ~300ms to ~500ms per link click by eliminating redirects. - Improves documentation reliability by using stable canonical endpoints. - Fixes critical path for security vulnerability reporting. 🔬 Measurement: - Verified using `time curl -L`: - `specification` repo redirect: ~780ms total. - `modelcontextprotocol` repo (canonical): ~230ms total (~550ms saving). - `spec` subdomain: Unreliable/Timeout. - `modelcontextprotocol.io/specification` (canonical): ~320ms total. 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. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates documentation across several files to canonicalize URLs, update repository paths, and refresh security reporting links. Review feedback identifies that changing the Contributor Covenant URLs to directory-style paths results in 404 errors, and suggests reverting to the original .html file extensions to maintain link functionality.
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
| version 2.0, available at | ||
| https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. | ||
| https://www.contributor-covenant.org/version/2/0/code_of_conduct/. |
There was a problem hiding this comment.
The URL https://www.contributor-covenant.org/version/2/0/code_of_conduct/ results in a 404 error. While the PR aims to canonicalize links by adding trailing slashes to avoid redirects, the versioned Code of Conduct on this site is hosted as a static .html file rather than a directory index. Reverting to the .html extension is necessary to maintain a functional link.
| https://www.contributor-covenant.org/version/2/0/code_of_conduct/. | |
| https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. |
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
| version 2.0, available at | ||
| https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. | ||
| https://www.contributor-covenant.org/version/2/0/code_of_conduct/. |
There was a problem hiding this comment.
The URL https://www.contributor-covenant.org/version/2/0/code_of_conduct/ results in a 404 error. The versioned documents at Contributor Covenant are served as individual files (e.g., .html) rather than directory-based paths. Please revert this change to ensure the link remains accessible to the community.
| https://www.contributor-covenant.org/version/2/0/code_of_conduct/. | |
| https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. |
1 participant
This PR implements performance optimizations by canonicalizing documentation links across the repository and fixing broken security reporting URLs.
By using canonical URLs, we eliminate unnecessary HTTP redirects (301/302/308), which reduces network latency by one full round-trip (RTT) per link click. Benchmarks show a reduction of approximately 300ms to 550ms in total load time for key documentation links.
Additionally, this PR:
SECURITY.mdthat were returning 404 errors.profile/directory.These changes align with the Bolt philosophy of eliminating inefficiency and ensuring every millisecond counts for the user experience.
PR created automatically by Jules for task 14319204576066992573 started by @soktri3