New API documentation - Githubissues

apify / apify-docs

This project is the home of Apify's documentation.

https://docs.apify.com

Apache License 2.0

26 stars 73 forks source link

New API documentation #869

Open mtrunkat opened 7 months ago

mtrunkat commented 7 months ago

I am opening this ticket to collect feedback on current documentation before we kick off the work on the new one.

Feedback from a power customer [Slack]:

He mentioned the need for better documentation, particularly at the Actor level, and clearer communication about any changes to data structures. He showed IBM API docs as an example.

jancurn commented 7 months ago

Points from me:

support for OpenAPI specs for the api
well integrated into https://docs.apify.com/
provides code examples in our client libraries for Node.js, Python, and ideally also CLI