crawl4ai icon indicating copy to clipboard operation
crawl4ai copied to clipboard

docs: fix outdated links to Docker guide and release notes

Open B-X-Y opened this issue 7 months ago โ€ข 1 comments

Summary

Fixes outdated links in the README.md file to point to the correct and current documentation pages.

Additionally, the pages under https://docs.crawl4ai.com/basic/ appear outdated and may need review.

List of files changed and why

README.md โ€“ Fixed broken or outdated documentation URLs.

How Has This Been Tested?

I manually checked each updated link to confirm that it resolves correctly and points to the intended documentation section.

Checklist:

  • [x] My code follows the style guidelines of this project
  • [x] I have performed a self-review of my own code
  • [ ] I have commented my code, particularly in hard-to-understand areas
  • [x] 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

Summary by CodeRabbit

  • Documentation
    • Updated documentation links in the README to use new URLs and updated the Docker Deployment Guide path.

B-X-Y avatar May 11 '25 04:05 B-X-Y

Walkthrough

The README.md file was updated to modify documentation URLs, specifically removing the .html extension from certain links and updating the Docker Deployment Guide path. No code logic or functional changes were made; only hyperlink references in the documentation were affected.

Changes

File(s) Change Summary
README.md Updated documentation URLs: corrected 0.7.0 release notes links, removed .html from 0.5.0 release notes URL, and changed Docker Deployment Guide path.

Poem

๐Ÿ‡
I hopped through README lines today,
Changed some links along the way.
No code to tweak, just docs to mendโ€”
A trailing dot, a path to bend.
Now guides are found with one less dot,
And Dockerโ€™s home is newly sought!


๐Ÿ“œ Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

๐Ÿ“ฅ Commits

Reviewing files that changed from the base of the PR and between 902933973f53d4d658242d8a329dcc1dbb876839 and d9f19f2856358327078bfba1fcae0575e0c75dfc.

๐Ÿ“’ Files selected for processing (1)
  • README.md (4 hunks)
โœ… Files skipped from review due to trivial changes (1)
  • README.md

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
๐Ÿชง Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar May 11 '25 04:05 coderabbitai[bot]

I am following up on this PR (opened initially on May 11). Iโ€™ve rebased it onto the latest main, resolved conflicts, and double-checked the updated links.

Since this was opened, a few new links were added to the README.md, which also pointed to outdated or incorrect documentation. Iโ€™ve fixed those as well.

Everything is ready for review. I'm happy to make any necessary changes.

B-X-Y avatar Jul 20 '25 01:07 B-X-Y