Skip to content

fix(docs): correct broken Hyperbrowser SDK reference links#6256

Open
sanjibani wants to merge 1 commit into
crewAIInc:mainfrom
sanjibani:fix/broken-link-hyperbrowser-tool
Open

fix(docs): correct broken Hyperbrowser SDK reference links#6256
sanjibani wants to merge 1 commit into
crewAIInc:mainfrom
sanjibani:fix/broken-link-hyperbrowser-tool

Conversation

@sanjibani

@sanjibani sanjibani commented Jun 20, 2026

Copy link
Copy Markdown

Summary

  • Fix two 404 links in lib/crewai-tools/src/crewai_tools/tools/hyperbrowser_load_tool/README.md:
    • https://docs.hyperbrowser.ai/reference/sdks/python/scrape#start-scrape-job-and-waithttps://www.hyperbrowser.ai/docs/home
    • https://docs.hyperbrowser.ai/reference/sdks/python/crawl#start-crawl-job-and-waithttps://docs.hyperbrowser.ai

Test plan

  • New URLs both return 200.
  • Old URLs both confirmed 404.

Summary by CodeRabbit

  • Documentation
    • Updated documentation reference links in the Hyperbrowser load tool's README file to direct users toward more general, platform-wide documentation resources instead of specific SDK documentation paths. This change improves documentation accessibility, reduces long-term maintenance burden, and provides greater flexibility for supporting future documentation updates, product changes, and overall platform evolution.

The /reference/sdks/python/scrape and /reference/sdks/python/crawl paths
both 404. Hyperbrowser restructured under /docs/* with the landing
page at /docs/home.

@corridor-security corridor-security 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.

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.

@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

A single documentation link on line 42 of the HyperbrowserLoadTool README is updated, replacing the previous Hyperbrowser Python SDK-specific URL with a more general Hyperbrowser documentation URL for the params argument under run.

Changes

HyperbrowserLoadTool README

Layer / File(s) Summary
Updated params docs link
lib/crewai-tools/src/crewai_tools/tools/hyperbrowser_load_tool/README.md
The "more information" URL for the params argument is changed from a specific SDK reference path to a general Hyperbrowser documentation URL.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately reflects the main change: fixing broken Hyperbrowser SDK documentation links in the README file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai 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.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9db2d44 and e482ab1.

📒 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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 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.ai

Repository: 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant