Skip to content

docs: reorganize the docs to mirror the Python client - #1083

Open
vdusek wants to merge 3 commits into
v3from
docs/reorganize-structure
Open

vdusek wants to merge 3 commits into
v3from
docs/reorganize-structure

Conversation

@vdusek

@vdusek vdusek commented Sep 25, 2026

Copy link
Copy Markdown
Contributor

Restructures the docs so they follow the Python client's layout and content, with differences only where the languages differ.

Structure

  • Concepts and guides use the Python page set and ids. usage-patterns is split into single/collection clients and nested clients, retries get their own page, and examples is split into the input, tasks, retrieve-data and webhooks guides.
  • New pages: Logging (@apify/log, run log redirection), Streaming resources, and Typed models (generated TS types, zod response validation, date and URL fields).
  • Python's asyncio page has no JS counterpart. Bundled environments is the last concept instead, and guide 04 handles webhooks where Python integrates pandas.
  • The old /docs/next URLs change. Released versioned docs are untouched, and apify-docs doesn't link to the old slugs.

Code samples

  • Samples live in docs/**/code/*.ts and load into .mdx pages through raw-loader, like in the Python repo.
  • pnpm tsc-check-docs type-checks them against src/ and runs in the CI lint job. oxlint and oxfmt cover them too, and the website markdownlint now includes .mdx.
  • The check turned up broken samples, which are fixed: start({ waitForFinish: 60 }) sent the option as the Actor input, the webhook route lacked its leading /, and the fetch HTTP client guide didn't type-check.

Closes #851

✍️ Drafted by Claude Code

@vdusek vdusek added the t-tooling Issues with this label are in the ownership of the tooling team. label Sep 25, 2026
@vdusek vdusek self-assigned this Sep 25, 2026
@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

⚠️ There are broken links in the documentation.

See more at https://github.com/apify/apify-client-js/actions/runs/36117686151#summary-108015595862

@vdusek
vdusek requested a review from janbuchar September 25, 2026 11:48
@vdusek
vdusek marked this pull request as ready for review September 25, 2026 11:48
@vdusek
vdusek requested a review from szaganek as a code owner September 25, 2026 11:48

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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