docs: Refactor documentation structure and add new content #579
Conversation
Reorganized documentation into a clearer three-tier structure: - 01_introduction: Separate pages for overview, installation, and quick start - 02_concepts: Core concepts including client architecture - 03_guides: Practical guides for common use cases with code examples Added new code examples for: - Calling actors (async/sync) - Pagination patterns (async/sync) - Streaming resources (async/sync) Streamlined the quick start guide to focus on essential concepts and moved detailed examples to the guides section. Updated sidebar navigation and Docusaurus config to reflect the new structure. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #579 +/- ##
=======================================
Coverage 76.01% 76.01%
=======================================
Files 42 42
Lines 2468 2468
=======================================
Hits 1876 1876
Misses 592 592
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
vdusek
left a comment
vdusek
left a comment
There was a problem hiding this comment.
Just ideas, otherwise, LGTM
| apify_client = ApifyClientAsync(TOKEN) | ||
|
|
||
| # Initialize the dataset client | ||
| dataset_client = apify_client.dataset('dataset-id') |
There was a problem hiding this comment.
Maybe it would be more practical to retrieve the dataset client by dataset's name?
| apify_client = ApifyClient(TOKEN) | ||
|
|
||
| # Initialize the dataset client | ||
| dataset_client = apify_client.dataset('dataset-id') |
There was a problem hiding this comment.
Maybe it would be more practical to retrieve the dataset client by dataset's name?
|
|
||
| async def main() -> None: | ||
| apify_client = ApifyClientAsync(TOKEN) | ||
| run_client = apify_client.run('MY-RUN-ID') |
There was a problem hiding this comment.
Maybe we can have a module-level constant MY_RUN_ID, similar to how we do it for TOKEN.
|
|
||
| def main() -> None: | ||
| apify_client = ApifyClient(TOKEN) | ||
| run_client = apify_client.run('MY-RUN-ID') |
There was a problem hiding this comment.
Maybe we can have a module-level constant MY_RUN_ID, similar to how we do it for TOKEN.
| apify_client = ApifyClient(TOKEN) | ||
|
|
||
| # Initialize the dataset client | ||
| dataset_client = apify_client.dataset('dataset-id') |
There was a problem hiding this comment.
Maybe we can have a module-level constant DATASET_NAME, similar to how we do it for TOKEN.
| apify_client = ApifyClientAsync(TOKEN) | ||
|
|
||
| # Initialize the dataset client | ||
| dataset_client = apify_client.dataset('dataset-id') |
There was a problem hiding this comment.
Maybe we can have a module-level constant DATASET_NAME, similar to how we do it for TOKEN.
Summary
Test plan
🤖 Generated with Claude Code