Skip to content

Improve API reference documentation #637

Closed

Description

@vdusek

Summary

The current API reference documentation is pretty messy and needs to be cleaned up. We've already improved the API reference in the SDK and Crawlee — now it's time to do the same for the Client.

Goals

  • The API reference should contain only public symbols (no internals)
  • It should be well-organized into clear sections:
    • Apify API client
    • HTTP clients
    • Resource clients
    • Models
    • (possibly more — TBD)

Context

This aligns with the documentation improvements already done in:

Activity

  1. added
    t-toolingIssues with this label are in the ownership of the tooling team.
    on Feb 24, 2026
  2. self-assigned this
    on Feb 24, 2026
  3. added this to the 3.0 milestone on Feb 24, 2026
  4. added 2 commits that reference this issue on Feb 24, 2026
    3966ec0
    6c9078a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

t-toolingIssues with this label are in the ownership of the tooling team.

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions