Skip to content

docs: Retitle and streamline the existing guides#939

Open
vdusek wants to merge 2 commits into
masterfrom
docs/improve-guides
Open

docs: Retitle and streamline the existing guides#939
vdusek wants to merge 2 commits into
masterfrom
docs/improve-guides

Conversation

@vdusek
Copy link
Copy Markdown
Contributor

@vdusek vdusek commented Jun 5, 2026

Improves the existing framework guides — clearer titles, flatter example code, and a few content fixes. The id: slugs and URLs are unchanged, so existing links keep working.

  • Retitle guides 01–06 to action-oriented names (e.g. "Use Crawlee" → "Building crawlers with Crawlee").
  • Flatten the scraper examples (BeautifulSoup, Parsel, Playwright, Selenium): extract a scrape_page helper and track crawl depth via Crawlee's built-in Request.crawl_depth instead of a manual user_data counter. Each stays a single file with one runnable "Run on Apify" block.
  • Crawlee & Scrapy guides: tidy the Apify Proxy wording, and fix the Scrapy __main__.py tab label/title plus a grammar nit.
  • Web server guide: fix the Actor.configuration.web_server_url/web_server_port references (the prose used non-existent container_* attributes), add a FastAPI example and an Actor Standby section, and renumber it 07 → 12 to make room for the new guides.
  • Quick-start: refresh the guides list.

@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels 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.91%. Comparing base (3f25d4a) to head (10c8199).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #939      +/-   ##
==========================================
+ Coverage   86.87%   86.91%   +0.03%     
==========================================
  Files          48       48              
  Lines        2942     2942              
==========================================
+ Hits         2556     2557       +1     
+ Misses        386      385       -1     
Flag Coverage Δ
e2e ?
integration 59.14% <ø> (+0.03%) ⬆️
unit 75.62% <ø> (ø)

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 changed the title docs: improve guides — consistent titles and flatter scraper examples docs: Flatten scraper examples and fix guide inaccuracies Jun 5, 2026
@vdusek vdusek force-pushed the docs/improve-guides branch from 0c1be46 to 65f8e0d Compare June 5, 2026 11:24
@vdusek vdusek marked this pull request as ready for review June 5, 2026 11:27
@vdusek vdusek requested a review from szaganek as a code owner June 5, 2026 11:27
@vdusek vdusek requested a review from janbuchar June 5, 2026 11:27
@vdusek vdusek changed the title docs: Flatten scraper examples and fix guide inaccuracies docs: Retitle and streamline the existing guides Jun 5, 2026
@vdusek vdusek requested review from Mantisus and removed request for janbuchar June 5, 2026 18:56
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.

2 participants