Skip to content

docs: standardize language, differentiate guides, and add closing notes#851

Open
vdusek wants to merge 3 commits intomasterfrom
docs/standardize-language-and-closing-notes
Open

docs: standardize language, differentiate guides, and add closing notes#851
vdusek wants to merge 3 commits intomasterfrom
docs/standardize-language-and-closing-notes

Conversation

@vdusek
Copy link
Copy Markdown
Contributor

@vdusek vdusek commented Apr 2, 2026

Summary

  • Rewrite opening paragraphs for 5 concept pages (proxy management, interacting with other Actors, API access, logging, configuration) to follow a consistent "what it does + why it matters" pattern
  • Standardize all 7 guide titles from gerund form ("Using X") to imperative form ("Use X"), including "Running webserver" → "Run a web server"
  • Differentiate Playwright and Selenium feature lists — Playwright now highlights auto-waiting, locator API, and network interception; Selenium highlights its broad ecosystem, WebDriver protocol, and flexible selection strategies
  • Standardize example intro phrasing to "The following example shows..." across Crawlee, Scrapy, and webserver guides; fix a stray backtick typo in the Crawlee guide
  • Remove duplicate opening sentence in the Crawlee guide
  • Add closing sentences with API reference/docs links to 5 concept pages that ended abruptly after code blocks

🤖 Generated with Claude Code

Rewrite concept page openings for consistency, standardize guide titles
to imperative form, differentiate Playwright/Selenium feature lists,
remove duplicate intro in Crawlee guide, and add closing cross-references
to pages that ended abruptly after code blocks.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@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 Apr 2, 2026
@vdusek vdusek self-assigned this Apr 2, 2026
@github-actions github-actions bot added this to the 137th sprint - Tooling team milestone Apr 2, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.64%. Comparing base (b40ad69) to head (c8ddfc9).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #851   +/-   ##
=======================================
  Coverage   86.64%   86.64%           
=======================================
  Files          48       48           
  Lines        2920     2920           
=======================================
  Hits         2530     2530           
  Misses        390      390           
Flag Coverage Δ
e2e 37.87% <ø> (ø)
integration 59.28% <ø> (ø)
unit 74.69% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 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 and others added 2 commits April 2, 2026 21:42
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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