docs: Retitle and improve the existing guides#939
Open
vdusek wants to merge 10 commits into
Open
Conversation
vdusek
added
adhoc
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #939 +/- ##
==========================================
+ Coverage 89.90% 89.93% +0.03%
==========================================
Files 49 49
Lines 3091 3091
==========================================
+ Hits 2779 2780 +1
+ Misses 312 311 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
vdusek
changed the title
1 task
vdusek
force-pushed
the
docs/improve-guides
branch
from
0c1be46 to
65f8e0d
Compare
vdusek
changed the title
Mantisus
approved these changes
Jun 7, 2026
Mantisus
left a comment
Mantisus
left a comment
Collaborator
There was a problem hiding this comment.
LGTM. Only one suggestion.
vdusek
changed the title
# Conflicts: # docs/01_introduction/quick-start.mdx
# Conflicts: # docs/01_introduction/quick-start.mdx
# Conflicts: # docs/01_introduction/quick-start.mdx
vdusek
added a commit
that referenced
this pull request
Jun 12, 2026
…921) Reviews the SDK documentation (Introduction, Concepts, Upgrading) against the codebase — fixes verified inaccuracies, unifies wording, and fills a few gaps. Does not touch the Guides section; those changes live in #939. ## Correctness fixes - **Storages**: documented the real `Dataset.export_to` (`content_type='csv'|'json'`); `export_to_csv`/`export_to_json` don't exist. - **Upgrading to v2**: `Actor.start_task` → `Actor.call_task` (accepts `Webhook`, returns `ActorRun`). - **Introduction**: Python requirement `3.10+` → `3.11+`. - **CONTRIBUTING**: development Python requirement `3.10` → `3.11`. - **PyPI metadata**: the "Release Notes" URL in `pyproject.toml` pointed at the v2 upgrade guide; now points at the v4 guide (wheel metadata is immutable after publish). - **Actor events**: corrected the `SYSTEM_INFO` / `MIGRATING` payloads and `Config` → `Configuration`, each event now links its real data type; fixed `04_actor_events.py` (passing a Pydantic model as logging `extra=` raises `TypeError`). - **Configuration**: `APIFY_PERSIST_STORAGE=0` → `APIFY_PURGE_ON_START=0`. - **Actor lifecycle**: fixed an empty `<ApiLink>`. - **Quick-start**: corrected the `__main__.py` description and tab label. ## Consistency & additions - Consistent capitalization ("Apify Proxy", "Apify Console", "Actor"); assorted grammar and upgrade-guide heading fixes; made an absolute self-link relative. - New **Storage clients** concept page with two runnable snippets (default `SmartApifyStorageClient`, single vs. shared request queue, `force_cloud`, custom client via `service_locator`); re-exported `StorageClient` from `apify.storage_clients`. - Added a `## Conclusion` to every concept page, expanded the Introduction feature list, and added a Configuration options table. ## TODO before merging - [ ] Mirror these changes into `website/versioned_docs/version-3.4/` so the published docs version reflects them, not only under "next": apply the edits to the existing Introduction, Concepts, and Upgrading pages, and clone the new Storage clients page (`docs/02_concepts/12_storage_clients.mdx` + its `code/12_*.py` snippets).
# Conflicts: # docs/03_guides/07_running_webserver.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.scrape_pagehelper and track crawl depth via Crawlee's built-inRequest.crawl_depthinstead of a manualuser_datacounter. Each stays a single file with one runnable "Run on Apify" block.__main__.pytab label/title plus a grammar nit.Actor.configuration.web_server_url/web_server_portreferences (the prose used non-existentcontainer_*attributes), add a FastAPI example and an Actor Standby section, and renumber it 07 → 12 to make room for the new guides.TODO before merging
website/versioned_docs/version-3.4/03_guides/copies (retitles, flattened example code, and the web server fixes) so the published docs version reflects them, not only under "next". The web server guide's 07 → 12 renumber only fits there once the new guides (docs: Add Scrapling guide #938, docs: Add guide on validating Actor input with Pydantic #941, docs: Add Crawl4AI guide #942, docs: Add Browser Use guide #943) are also cloned into version-3.4, so coordinate the version-3.4 update across those PRs.