Skip to content

docs: Fix inaccuracies, unify wording, and expand SDK documentation#921

Open
vdusek wants to merge 1 commit into
masterfrom
docs/fix-and-expand-docs
Open

docs: Fix inaccuracies, unify wording, and expand SDK documentation#921
vdusek wants to merge 1 commit into
masterfrom
docs/fix-and-expand-docs

Conversation

@vdusek
Copy link
Copy Markdown
Contributor

@vdusek vdusek commented May 29, 2026

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_taskActor.call_task (accepts Webhook, returns ActorRun).
  • Introduction: Python requirement 3.10+3.11+.
  • Actor events: corrected the SYSTEM_INFO / MIGRATING payloads and ConfigConfiguration, 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=0APIFY_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.

@vdusek vdusek requested a review from szaganek as a code owner May 29, 2026 17:20
@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 May 29, 2026
@vdusek vdusek self-assigned this May 29, 2026
@github-actions github-actions Bot added this to the 141st sprint - Tooling team milestone May 29, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 29, 2026

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #921      +/-   ##
==========================================
+ Coverage   86.87%   86.98%   +0.10%     
==========================================
  Files          48       48              
  Lines        2942     2942              
==========================================
+ Hits         2556     2559       +3     
+ Misses        386      383       -3     
Flag Coverage Δ
e2e 37.76% <100.00%> (ø)
integration 59.14% <100.00%> (+0.03%) ⬆️
unit 75.69% <100.00%> (+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 marked this pull request as draft May 29, 2026 17:24
@vdusek vdusek removed the request for review from szaganek May 29, 2026 17:24
@vdusek vdusek force-pushed the docs/fix-and-expand-docs branch from 83e5f9b to 547af69 Compare June 4, 2026 13:51
@vdusek vdusek changed the title docs: fix inaccuracies and expand SDK documentation docs: fix inaccuracies, unify wording, and expand SDK documentation Jun 4, 2026
@vdusek vdusek added the documentation Improvements or additions to documentation. label Jun 4, 2026
@vdusek vdusek marked this pull request as ready for review June 4, 2026 14:42
@vdusek vdusek changed the title docs: fix inaccuracies, unify wording, and expand SDK documentation docs: Fix inaccuracies, unify wording, and expand SDK documentation Jun 4, 2026
@vdusek vdusek requested a review from szaganek June 4, 2026 14:43
@vdusek vdusek force-pushed the docs/fix-and-expand-docs branch 3 times, most recently from 96d0d8a to 6d81eac Compare June 5, 2026 10:49
@vdusek vdusek force-pushed the docs/fix-and-expand-docs branch from 6d81eac to 7ca6d59 Compare June 5, 2026 11:25
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. documentation Improvements or additions to documentation. 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