-
Notifications
You must be signed in to change notification settings - Fork 14
docs: consolidate overview page #574
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
remove bold add italics update links
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #574 +/- ##
=======================================
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:
|
| - Synchronous and asynchronous interfaces for flexible integration | ||
| - Automatic retries for improved reliability | ||
| - JSON encoding with UTF-8 for all requests and responses | ||
| - Comprehensive API coverage for [Actors](/platform/actors), [datasets]/platform/storage/dataset), [key-value stores](/platform/storage/key-value-store), and more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - Comprehensive API coverage for [Actors](/platform/actors), [datasets]/platform/storage/dataset), [key-value stores](/platform/storage/key-value-store), and more | |
| - Comprehensive API coverage for [Actors](/platform/actors), [datasets](/platform/storage/dataset), [key-value stores](/platform/storage/key-value-store), and more |
| @@ -0,0 +1,155 @@ | |||
| --- | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same issue. Can the overview page be brought one level up? Overview page under an overview section is kinda weird UX
|
|
||
| Key features: | ||
|
|
||
| - Synchronous and asynchronous interfaces for flexible integration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
MInor: For integration of what, where? I'd consider specifying.
| ```sh | ||
| pip --version | ||
| ``` | ||
|
|
||
| If these commands return the respective versions, you're ready to continue. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you actually need to check the version of pip, or do you only need to check that it's correctly configured?
|
|
||
| ## Authentication and initialization | ||
|
|
||
| To use the client, you need an [API token](/platform/integrations/api#api-token). You can find your token under the [Integrations](https://console.apify.com/account/integrations) tab in Apify Console. Copy the token and initialize the client by providing it as a parameter to the `ApifyClient` constructor. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add "Have an Apify account" to prereqs? It sounds basic, but you actually do need it :D
No description provided.