Skip to content

Conversation

@SohamKukreti
Copy link
Collaborator

Summary

This PR does the following:

  • Switch installs to pip install -r requirements.txt (tutorial and app docs)
  • Update local run steps to python server.py and http://localhost:8000
  • Set default PORT to 8000; update port-in-use commands and alt port 8001
  • Replace unsupported :contains() example with accessible attribute selector
  • Update example URLs in tutorial servers to 127.0.0.1:8000
  • Add “Identity-based crawling” section with crwl profiles CLI workflow and code usage
  • Replace legacy-docs note with sponsorship message in docs/md_v2/index.md
  • Minor copy and consistency fixes across pages

Addresses #1511

List of files changed and why

  • docs/examples/c4a_script/tutorial/README.md: Use pip install -r requirements.txt; update local URL to http://localhost:8000; set config example PORT = 8000; adjust port-in-use commands and alt port to 8001.

  • docs/examples/c4a_script/tutorial/server.py: Update example script URL in get_examples() to http://127.0.0.1:8000/playground/ to match new port.

  • docs/md_v2/advanced/identity-based-crawling.md: Add CLI-driven identity-based crawling workflow using crwl profiles with steps and usage snippet.

  • docs/md_v2/apps/c4a-script/README.md: Switch install to requirements.txt; update run instructions to python server.py and http://localhost:8000; set config PORT = 8000; update port-in-use commands and alt port to 8001.

  • docs/md_v2/apps/c4a-script/server.py: Change example URL to 127.0.0.1:8000 and default env PORT fallback to 8000.

  • docs/md_v2/core/c4a-script.md: Replace invalid :contains() selector; add accessible-attribute button example button[aria-label="Search"][title="Search"]; update local setup to requirements.txt, server.py, and http://localhost:8000.

  • docs/md_v2/index.md: Replace legacy-docs note with sponsorship CTA to encourage supporting development.

How Has This Been Tested?

Verified manually and served the docs to test them.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added/updated unit tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

…awling, and add sponsorship CTA

- Switch installs to pip install -r requirements.txt (tutorial and app docs)
- Update local run steps to python server.py and http://localhost:8000
- Set default PORT to 8000; update port-in-use commands and alt port 8001
- Replace unsupported :contains() example with accessible attribute selector
- Update example URLs in tutorial servers to 127.0.0.1:8000
- Add “Identity-based crawling” section with crwl profiles CLI workflow and code usage
- Replace legacy-docs note with sponsorship message in docs/md_v2/index.md
- Minor copy and consistency fixes across pages
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 3, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/update-documentation

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.

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