fix(docs): correct broken Hyperbrowser SDK reference links#6256
fix(docs): correct broken Hyperbrowser SDK reference links#6256sanjibani wants to merge 1 commit into
Conversation
The /reference/sdks/python/scrape and /reference/sdks/python/crawl paths both 404. Hyperbrowser restructured under /docs/* with the landing page at /docs/home.
There was a problem hiding this comment.
Summary: This PR updates Hyperbrowser documentation links only and does not change executable code or security boundaries.
Risk: Low risk. No exploitable security vulnerabilities were identified because the change only affects README reference URLs and does not impact authentication, authorization, data handling, or external integration behavior.
📝 WalkthroughWalkthroughA single documentation link on line 42 of the ChangesHyperbrowserLoadTool README
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@lib/crewai-tools/src/crewai_tools/tools/hyperbrowser_load_tool/README.md`:
- Line 42: In the README.md file for the hyperbrowser_load_tool, the params
documentation line references two URLs for the HyperBrowser documentation, but
the second URL (https://docs.hyperbrowser.ai) responds with an HTTP 308 redirect
instead of HTTP 200. Remove the second URL reference and the "or" conjunction
from the params documentation, keeping only the primary URL
(https://www.hyperbrowser.ai/docs/home) which returns a proper 200 response.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 2bfd08e7-0177-4807-883b-83da79376557
📒 Files selected for processing (1)
lib/crewai-tools/src/crewai_tools/tools/hyperbrowser_load_tool/README.md
| - `url`: The base URL to start scraping or crawling from. | ||
| - `operation`: Optional. Specifies the operation to perform on the website. Either 'scrape' or 'crawl'. Defaults is 'scrape'. | ||
| - `params`: Optional. Specifies the params for the operation. For more information on the supported params, visit https://docs.hyperbrowser.ai/reference/sdks/python/scrape#start-scrape-job-and-wait or https://docs.hyperbrowser.ai/reference/sdks/python/crawl#start-crawl-job-and-wait. | ||
| - `params`: Optional. Specifies the params for the operation. For more information on the supported params, visit https://www.hyperbrowser.ai/docs/home or https://docs.hyperbrowser.ai. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify both documentation URLs return 200 status codes
echo "Checking https://www.hyperbrowser.ai/docs/home"
curl -s -o /dev/null -w "HTTP Status: %{http_code}\n" https://www.hyperbrowser.ai/docs/home
echo "Checking https://docs.hyperbrowser.ai"
curl -s -o /dev/null -w "HTTP Status: %{http_code}\n" https://docs.hyperbrowser.aiRepository: crewAIInc/crewAI
Length of output: 179
One documentation URL redirects instead of returning a 200 response.
The second URL (https://docs.hyperbrowser.ai) returns HTTP 308 (permanent redirect) rather than 200. While the redirect is followable, this adds unnecessary latency and contradicts the PR's claim that both URLs were verified to return 200 status codes. Consider using only the primary URL (https://www.hyperbrowser.ai/docs/home) which returns 200, or update the documentation to reference a URL that responds directly without redirects.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@lib/crewai-tools/src/crewai_tools/tools/hyperbrowser_load_tool/README.md` at
line 42, In the README.md file for the hyperbrowser_load_tool, the params
documentation line references two URLs for the HyperBrowser documentation, but
the second URL (https://docs.hyperbrowser.ai) responds with an HTTP 308 redirect
instead of HTTP 200. Remove the second URL reference and the "or" conjunction
from the params documentation, keeping only the primary URL
(https://www.hyperbrowser.ai/docs/home) which returns a proper 200 response.
Summary
lib/crewai-tools/src/crewai_tools/tools/hyperbrowser_load_tool/README.md:https://docs.hyperbrowser.ai/reference/sdks/python/scrape#start-scrape-job-and-wait→https://www.hyperbrowser.ai/docs/homehttps://docs.hyperbrowser.ai/reference/sdks/python/crawl#start-crawl-job-and-wait→https://docs.hyperbrowser.aiTest plan
Summary by CodeRabbit