Skip to content

docs: Add Crawl4AI guide#942

Open
vdusek wants to merge 3 commits into
masterfrom
docs/crawl4ai-guide
Open

docs: Add Crawl4AI guide#942
vdusek wants to merge 3 commits into
masterfrom
docs/crawl4ai-guide

Conversation

@vdusek
Copy link
Copy Markdown
Contributor

@vdusek vdusek commented Jun 5, 2026

Adds a guide for the Crawl4AI LLM-friendly web crawler in Apify Actors, following the structure of the existing scraping-library guides.

  • docs/03_guides/08_crawl4ai.mdx — the guide: introduction & features, a runnable example Actor that crawls pages into LLM-ready markdown, Apify Proxy integration, and the Dockerfile / base-image setup.
  • code/08_crawl4ai.py — runnable single-file example: a recursive markdown scraper using Crawl4AI's AsyncWebCrawler through Apify Proxy.
  • Quick-start guides list updated.

Built on the Python 3.13 Playwright base image — Crawl4AI pins lxml < 6, which has no cp314 wheels yet, so the 3.14 image would force a slow source build; the base image's browser is reused, so no extra browser-install step is needed.

Verified locally and on the platform (build + run SUCCEEDED), with output egressing through Apify Proxy. Lint + type-check pass.

Closes: #836

@vdusek vdusek added the t-tooling Issues with this label are in the ownership of the tooling team. label Jun 5, 2026
@vdusek vdusek self-assigned this Jun 5, 2026
@github-actions github-actions Bot added this to the 142nd sprint - Tooling team milestone Jun 5, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.94%. Comparing base (3f25d4a) to head (d6d4dcd).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #942      +/-   ##
==========================================
+ Coverage   86.87%   86.94%   +0.06%     
==========================================
  Files          48       48              
  Lines        2942     2942              
==========================================
+ Hits         2556     2558       +2     
+ Misses        386      384       -2     
Flag Coverage Δ
e2e 37.76% <ø> (ø)
integration 59.10% <ø> (ø)
unit 75.69% <ø> (+0.06%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@vdusek vdusek added the adhoc Ad-hoc unplanned task added during the sprint. label Jun 5, 2026
@vdusek vdusek requested a review from Mantisus June 5, 2026 18:56
@vdusek vdusek changed the title docs: add Crawl4AI guide docs: Add Crawl4AI guide Jun 5, 2026
@vdusek vdusek marked this pull request as ready for review June 5, 2026 18:57
@vdusek vdusek requested a review from szaganek as a code owner June 5, 2026 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation guides for LLM-based web scraping frameworks

2 participants