From 0e9af1be0ec08780d51a77d65e5850da88d72a32 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 17 Jun 2026 11:13:44 +0200 Subject: [PATCH 1/2] docs: fix broken relative links on the SDK overview page --- docs/01_introduction/index.mdx | 24 +++++++++---------- .../version-0.2/01-introduction/index.mdx | 2 +- .../version-1.7/01-introduction/index.mdx | 2 +- .../version-2.7/01_introduction/index.mdx | 2 +- .../version-3.4/01_introduction/index.mdx | 24 +++++++++---------- 5 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/01_introduction/index.mdx b/docs/01_introduction/index.mdx index 567e4db10..2b0f99b09 100644 --- a/docs/01_introduction/index.mdx +++ b/docs/01_introduction/index.mdx @@ -25,22 +25,22 @@ For more context, read the [Actor whitepaper](https://whitepaper.actor/). ## Features -- Run the full Actor lifecycle inside `async with Actor:`, covering init, exit, failures, status messages, rebooting, and metamorphing ([Actor lifecycle](../concepts/actor-lifecycle)). -- Read Actor input validated against your input schema with `Actor.get_input()`, including automatic decryption of secret fields ([Actor input](../concepts/actor-input)). -- Read and write datasets, key-value stores, and request queues, locally or on the platform ([Working with storages](../concepts/storages)). -- React to platform events such as system info, migration, and abort, and persist state across migrations and restarts ([Actor events](../concepts/actor-events)). -- Route requests through Apify Proxy with group selection, country targeting, and rotation, with session and tiered-proxy support ([Proxy management](../concepts/proxy-management)). -- Start, call, and abort other Actors and tasks, and attach webhooks to run events ([Interacting with other Actors](../concepts/interacting-with-other-actors), [Webhooks](../concepts/webhooks)). -- Monetize your Actor with pay-per-event charging ([Pay-per-event](../concepts/pay-per-event)). -- Reach the full [Apify API](https://docs.apify.com/api/v2) through a preconfigured `ApifyClient` ([Accessing the Apify API](../concepts/access-apify-api)). +- Run the full Actor lifecycle inside `async with Actor:`, covering init, exit, failures, status messages, rebooting, and metamorphing ([Actor lifecycle](./concepts/actor-lifecycle)). +- Read Actor input validated against your input schema with `Actor.get_input()`, including automatic decryption of secret fields ([Actor input](./concepts/actor-input)). +- Read and write datasets, key-value stores, and request queues, locally or on the platform ([Working with storages](./concepts/storages)). +- React to platform events such as system info, migration, and abort, and persist state across migrations and restarts ([Actor events](./concepts/actor-events)). +- Route requests through Apify Proxy with group selection, country targeting, and rotation, with session and tiered-proxy support ([Proxy management](./concepts/proxy-management)). +- Start, call, and abort other Actors and tasks, and attach webhooks to run events ([Interacting with other Actors](./concepts/interacting-with-other-actors), [Webhooks](./concepts/webhooks)). +- Monetize your Actor with pay-per-event charging ([Pay-per-event](./concepts/pay-per-event)). +- Reach the full [Apify API](https://docs.apify.com/api/v2) through a preconfigured `ApifyClient` ([Accessing the Apify API](./concepts/access-apify-api)). ## What you can build Almost any Python project can become an Actor, including projects for: -- **Web scraping and crawling** - The SDK is fully compatible with [Crawlee](https://crawlee.dev/python), which makes Apify a natural place to deploy and scale your crawlers (see the [Crawlee guide](../guides/crawlee)). It also works with other popular scraping libraries, such as [Scrapy](../guides/scrapy), [Scrapling](../guides/scrapling), or [Crawl4AI](../guides/crawl4ai). -- **Browser automation** - Drive a real browser with [Playwright](../guides/playwright) or [Selenium](../guides/selenium), or with higher-level tools such as [Browser Use](../guides/browser-use). -- **Web servers and APIs** - Run a [web server](../guides/running-webserver) inside an Actor to serve HTTP requests, for example to expose your scraper as a live API. +- **Web scraping and crawling** - The SDK is fully compatible with [Crawlee](https://crawlee.dev/python), which makes Apify a natural place to deploy and scale your crawlers (see the [Crawlee guide](./guides/crawlee)). It also works with other popular scraping libraries, such as [Scrapy](./guides/scrapy), [Scrapling](./guides/scrapling), or [Crawl4AI](./guides/crawl4ai). +- **Browser automation** - Drive a real browser with [Playwright](./guides/playwright) or [Selenium](./guides/selenium), or with higher-level tools such as [Browser Use](./guides/browser-use). +- **Web servers and APIs** - Run a [web server](./guides/running-webserver) inside an Actor to serve HTTP requests, for example to expose your scraper as a live API. - **AI agents** - Host agents built with your framework of choice. Ready-made Actor templates cover [PydanticAI](https://apify.com/templates/python-pydanticai), [CrewAI](https://apify.com/templates/python-crewai), [LangGraph](https://apify.com/templates/python-langgraph), [LlamaIndex](https://apify.com/templates/python-llamaindex-agent), and [Smolagents](https://apify.com/templates/python-smolagents). - **MCP servers** - Deploy a Python MCP server as an Actor and make its tools available to any MCP client. See the [MCP server](https://apify.com/templates/python-mcp-empty) and [MCP proxy](https://apify.com/templates/python-mcp-proxy) templates. @@ -48,7 +48,7 @@ Whatever you build, the Apify SDK doesn't lock you into a particular framework. ## Quick start -To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running Python Actors locally, refer to the [quick start guide](./quick-start). +To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running Python Actors locally, refer to the [quick start guide](./introduction/quick-start). Explore the Guides section in the sidebar for a deeper understanding of the SDK's features and best practices. diff --git a/website/versioned_docs/version-0.2/01-introduction/index.mdx b/website/versioned_docs/version-0.2/01-introduction/index.mdx index 11b15b71b..2ba93baf1 100644 --- a/website/versioned_docs/version-0.2/01-introduction/index.mdx +++ b/website/versioned_docs/version-0.2/01-introduction/index.mdx @@ -33,7 +33,7 @@ If you're new to Apify, learn [what is Apify](https://docs.apify.com/platform/ab ## Quick start -To create and run Actors through Apify Console, see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template). For creating and running Python Actors locally, refer to the [quick start guide](./quick-start). +To create and run Actors through Apify Console, see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template). For creating and running Python Actors locally, refer to the [quick start guide](./introduction/quick-start). ## Installation diff --git a/website/versioned_docs/version-1.7/01-introduction/index.mdx b/website/versioned_docs/version-1.7/01-introduction/index.mdx index 575abdcf9..8eb308f39 100644 --- a/website/versioned_docs/version-1.7/01-introduction/index.mdx +++ b/website/versioned_docs/version-1.7/01-introduction/index.mdx @@ -26,7 +26,7 @@ If you're new to Apify, learn [what is Apify](https://docs.apify.com/platform/ab ## Quick start -To create and run Actors through Apify Console, see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template). For creating and running Python Actors locally, refer to the [quick start guide](./quick-start). +To create and run Actors through Apify Console, see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template). For creating and running Python Actors locally, refer to the [quick start guide](./introduction/quick-start). Explore the Guides section in the sidebar for a deeper understanding of the SDK's features and best practices. diff --git a/website/versioned_docs/version-2.7/01_introduction/index.mdx b/website/versioned_docs/version-2.7/01_introduction/index.mdx index 168370ab0..d4ad8bd48 100644 --- a/website/versioned_docs/version-2.7/01_introduction/index.mdx +++ b/website/versioned_docs/version-2.7/01_introduction/index.mdx @@ -26,7 +26,7 @@ If you're new to Apify, refer to the Apify platform documentation to learn [what ## Quick start -To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running Python Actors locally, refer to the [quick start guide](./quick-start). +To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running Python Actors locally, refer to the [quick start guide](./introduction/quick-start). Explore the Guides section in the sidebar for a deeper understanding of the SDK's features and best practices. diff --git a/website/versioned_docs/version-3.4/01_introduction/index.mdx b/website/versioned_docs/version-3.4/01_introduction/index.mdx index bd41b55eb..e68310869 100644 --- a/website/versioned_docs/version-3.4/01_introduction/index.mdx +++ b/website/versioned_docs/version-3.4/01_introduction/index.mdx @@ -25,22 +25,22 @@ For more context, read the [Actor whitepaper](https://whitepaper.actor/). ## Features -- Run the full Actor lifecycle inside `async with Actor:`, covering init, exit, failures, status messages, rebooting, and metamorphing ([Actor lifecycle](../concepts/actor-lifecycle)). -- Read Actor input validated against your input schema with `Actor.get_input()`, including automatic decryption of secret fields ([Actor input](../concepts/actor-input)). -- Read and write datasets, key-value stores, and request queues, locally or on the platform ([Working with storages](../concepts/storages)). -- React to platform events such as system info, migration, and abort, and persist state across migrations and restarts ([Actor events](../concepts/actor-events)). -- Route requests through Apify Proxy with group selection, country targeting, and rotation, with session and tiered-proxy support ([Proxy management](../concepts/proxy-management)). -- Start, call, and abort other Actors and tasks, and attach webhooks to run events ([Interacting with other Actors](../concepts/interacting-with-other-actors), [Webhooks](../concepts/webhooks)). -- Monetize your Actor with pay-per-event charging ([Pay-per-event](../concepts/pay-per-event)). -- Reach the full [Apify API](https://docs.apify.com/api/v2) through a preconfigured `ApifyClient` ([Accessing the Apify API](../concepts/access-apify-api)). +- Run the full Actor lifecycle inside `async with Actor:`, covering init, exit, failures, status messages, rebooting, and metamorphing ([Actor lifecycle](./concepts/actor-lifecycle)). +- Read Actor input validated against your input schema with `Actor.get_input()`, including automatic decryption of secret fields ([Actor input](./concepts/actor-input)). +- Read and write datasets, key-value stores, and request queues, locally or on the platform ([Working with storages](./concepts/storages)). +- React to platform events such as system info, migration, and abort, and persist state across migrations and restarts ([Actor events](./concepts/actor-events)). +- Route requests through Apify Proxy with group selection, country targeting, and rotation, with session and tiered-proxy support ([Proxy management](./concepts/proxy-management)). +- Start, call, and abort other Actors and tasks, and attach webhooks to run events ([Interacting with other Actors](./concepts/interacting-with-other-actors), [Webhooks](./concepts/webhooks)). +- Monetize your Actor with pay-per-event charging ([Pay-per-event](./concepts/pay-per-event)). +- Reach the full [Apify API](https://docs.apify.com/api/v2) through a preconfigured `ApifyClient` ([Accessing the Apify API](./concepts/access-apify-api)). ## What you can build Almost any Python project can become an Actor, including projects for: -- **Web scraping and crawling** - The SDK is fully compatible with [Crawlee](https://crawlee.dev/python), which makes Apify a natural place to deploy and scale your crawlers (see the [Crawlee guide](../guides/crawlee)). It also works with other popular scraping libraries, such as [Scrapy](../guides/scrapy), [Scrapling](../guides/scrapling), or [Crawl4AI](../guides/crawl4ai). -- **Browser automation** - Drive a real browser with [Playwright](../guides/playwright) or [Selenium](../guides/selenium), or with higher-level tools such as [Browser Use](../guides/browser-use). -- **Web servers and APIs** - Run a [web server](../guides/running-webserver) inside an Actor to serve HTTP requests, for example to expose your scraper as a live API. +- **Web scraping and crawling** - The SDK is fully compatible with [Crawlee](https://crawlee.dev/python), which makes Apify a natural place to deploy and scale your crawlers (see the [Crawlee guide](./guides/crawlee)). It also works with other popular scraping libraries, such as [Scrapy](./guides/scrapy), [Scrapling](./guides/scrapling), or [Crawl4AI](./guides/crawl4ai). +- **Browser automation** - Drive a real browser with [Playwright](./guides/playwright) or [Selenium](./guides/selenium), or with higher-level tools such as [Browser Use](./guides/browser-use). +- **Web servers and APIs** - Run a [web server](./guides/running-webserver) inside an Actor to serve HTTP requests, for example to expose your scraper as a live API. - **AI agents** - Host agents built with your framework of choice. Ready-made Actor templates cover [PydanticAI](https://apify.com/templates/python-pydanticai), [CrewAI](https://apify.com/templates/python-crewai), [LangGraph](https://apify.com/templates/python-langgraph), [LlamaIndex](https://apify.com/templates/python-llamaindex-agent), and [Smolagents](https://apify.com/templates/python-smolagents). - **MCP servers** - Deploy a Python MCP server as an Actor and make its tools available to any MCP client. See the [MCP server](https://apify.com/templates/python-mcp-empty) and [MCP proxy](https://apify.com/templates/python-mcp-proxy) templates. @@ -48,7 +48,7 @@ Whatever you build, the Apify SDK doesn't lock you into a particular framework. ## Quick start -To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running Python Actors locally, refer to the [quick start guide](./quick-start). +To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running Python Actors locally, refer to the [quick start guide](./introduction/quick-start). Explore the Guides section in the sidebar for a deeper understanding of the SDK's features and best practices. From 84ffccb2f2bc80b54f9222873aab256f65518dc5 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 17 Jun 2026 11:30:09 +0200 Subject: [PATCH 2/2] docs: serve the quick start page at /quick-start --- docs/01_introduction/index.mdx | 2 +- docs/01_introduction/quick-start.mdx | 1 + website/versioned_docs/version-0.2/01-introduction/index.mdx | 2 +- .../version-0.2/01-introduction/quick-start.mdx | 1 + website/versioned_docs/version-1.7/01-introduction/index.mdx | 2 +- .../version-1.7/01-introduction/quick-start.mdx | 1 + .../version-1.7/02-guides/01-requests-and-httpx.mdx | 4 ++-- website/versioned_docs/version-2.7/01_introduction/index.mdx | 2 +- .../version-2.7/01_introduction/quick-start.mdx | 1 + website/versioned_docs/version-3.4/01_introduction/index.mdx | 2 +- .../version-3.4/01_introduction/quick-start.mdx | 1 + 11 files changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/01_introduction/index.mdx b/docs/01_introduction/index.mdx index 2b0f99b09..133c6a478 100644 --- a/docs/01_introduction/index.mdx +++ b/docs/01_introduction/index.mdx @@ -48,7 +48,7 @@ Whatever you build, the Apify SDK doesn't lock you into a particular framework. ## Quick start -To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running Python Actors locally, refer to the [quick start guide](./introduction/quick-start). +To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running Python Actors locally, refer to the [quick start guide](./quick-start). Explore the Guides section in the sidebar for a deeper understanding of the SDK's features and best practices. diff --git a/docs/01_introduction/quick-start.mdx b/docs/01_introduction/quick-start.mdx index 3d344458e..b3476a9e1 100644 --- a/docs/01_introduction/quick-start.mdx +++ b/docs/01_introduction/quick-start.mdx @@ -1,6 +1,7 @@ --- id: quick-start title: Quick start +slug: /quick-start description: Get started with the Apify SDK for Python by creating your first Actor and learning the basics. --- diff --git a/website/versioned_docs/version-0.2/01-introduction/index.mdx b/website/versioned_docs/version-0.2/01-introduction/index.mdx index 2ba93baf1..11b15b71b 100644 --- a/website/versioned_docs/version-0.2/01-introduction/index.mdx +++ b/website/versioned_docs/version-0.2/01-introduction/index.mdx @@ -33,7 +33,7 @@ If you're new to Apify, learn [what is Apify](https://docs.apify.com/platform/ab ## Quick start -To create and run Actors through Apify Console, see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template). For creating and running Python Actors locally, refer to the [quick start guide](./introduction/quick-start). +To create and run Actors through Apify Console, see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template). For creating and running Python Actors locally, refer to the [quick start guide](./quick-start). ## Installation diff --git a/website/versioned_docs/version-0.2/01-introduction/quick-start.mdx b/website/versioned_docs/version-0.2/01-introduction/quick-start.mdx index 67882bbe0..648433c26 100644 --- a/website/versioned_docs/version-0.2/01-introduction/quick-start.mdx +++ b/website/versioned_docs/version-0.2/01-introduction/quick-start.mdx @@ -1,6 +1,7 @@ --- id: quick-start title: Quick start +slug: /quick-start sidebar_label: Quick start description: 'Get started with the Apify SDK for Python by creating your first Actor and learning the basics.' --- diff --git a/website/versioned_docs/version-1.7/01-introduction/index.mdx b/website/versioned_docs/version-1.7/01-introduction/index.mdx index 8eb308f39..575abdcf9 100644 --- a/website/versioned_docs/version-1.7/01-introduction/index.mdx +++ b/website/versioned_docs/version-1.7/01-introduction/index.mdx @@ -26,7 +26,7 @@ If you're new to Apify, learn [what is Apify](https://docs.apify.com/platform/ab ## Quick start -To create and run Actors through Apify Console, see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template). For creating and running Python Actors locally, refer to the [quick start guide](./introduction/quick-start). +To create and run Actors through Apify Console, see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template). For creating and running Python Actors locally, refer to the [quick start guide](./quick-start). Explore the Guides section in the sidebar for a deeper understanding of the SDK's features and best practices. diff --git a/website/versioned_docs/version-1.7/01-introduction/quick-start.mdx b/website/versioned_docs/version-1.7/01-introduction/quick-start.mdx index 7bed47f37..9c35d8c06 100644 --- a/website/versioned_docs/version-1.7/01-introduction/quick-start.mdx +++ b/website/versioned_docs/version-1.7/01-introduction/quick-start.mdx @@ -1,6 +1,7 @@ --- id: quick-start title: Quick start +slug: /quick-start sidebar_label: Quick start description: 'Get started with the Apify SDK for Python by creating your first Actor and learning the basics.' --- diff --git a/website/versioned_docs/version-1.7/02-guides/01-requests-and-httpx.mdx b/website/versioned_docs/version-1.7/02-guides/01-requests-and-httpx.mdx index dbc31ad70..9d3ec4889 100644 --- a/website/versioned_docs/version-1.7/02-guides/01-requests-and-httpx.mdx +++ b/website/versioned_docs/version-1.7/02-guides/01-requests-and-httpx.mdx @@ -16,7 +16,7 @@ The [`requests`](https://requests.readthedocs.io) library is one of the most pop To use it in your Actors, no special configuration is needed. Just put `requests` in your `requirements.txt` file, -[reinstall dependencies](../introduction/quick-start#adding-dependencies) if you're running the Actor locally, +[reinstall dependencies](../quick-start#adding-dependencies) if you're running the Actor locally, and you're good to go. ```python title="src/main.py" @@ -62,7 +62,7 @@ making it ideal for large-scale, parallel web scraping. To use it in your Actors, no special configuration is needed. Just put `httpx` in your `requirements.txt` file, -[reinstall dependencies](../introduction/quick-start#adding-dependencies) if you're running the Actor locally, +[reinstall dependencies](../quick-start#adding-dependencies) if you're running the Actor locally, and you're good to go. ```python title="src/main.py" diff --git a/website/versioned_docs/version-2.7/01_introduction/index.mdx b/website/versioned_docs/version-2.7/01_introduction/index.mdx index d4ad8bd48..168370ab0 100644 --- a/website/versioned_docs/version-2.7/01_introduction/index.mdx +++ b/website/versioned_docs/version-2.7/01_introduction/index.mdx @@ -26,7 +26,7 @@ If you're new to Apify, refer to the Apify platform documentation to learn [what ## Quick start -To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running Python Actors locally, refer to the [quick start guide](./introduction/quick-start). +To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running Python Actors locally, refer to the [quick start guide](./quick-start). Explore the Guides section in the sidebar for a deeper understanding of the SDK's features and best practices. diff --git a/website/versioned_docs/version-2.7/01_introduction/quick-start.mdx b/website/versioned_docs/version-2.7/01_introduction/quick-start.mdx index 6864e89e4..643eef96c 100644 --- a/website/versioned_docs/version-2.7/01_introduction/quick-start.mdx +++ b/website/versioned_docs/version-2.7/01_introduction/quick-start.mdx @@ -1,6 +1,7 @@ --- id: quick-start title: Quick start +slug: /quick-start sidebar_label: Quick start description: 'Get started with the Apify SDK for Python by creating your first Actor and learning the basics.' --- diff --git a/website/versioned_docs/version-3.4/01_introduction/index.mdx b/website/versioned_docs/version-3.4/01_introduction/index.mdx index e68310869..638f5593a 100644 --- a/website/versioned_docs/version-3.4/01_introduction/index.mdx +++ b/website/versioned_docs/version-3.4/01_introduction/index.mdx @@ -48,7 +48,7 @@ Whatever you build, the Apify SDK doesn't lock you into a particular framework. ## Quick start -To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running Python Actors locally, refer to the [quick start guide](./introduction/quick-start). +To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running Python Actors locally, refer to the [quick start guide](./quick-start). Explore the Guides section in the sidebar for a deeper understanding of the SDK's features and best practices. diff --git a/website/versioned_docs/version-3.4/01_introduction/quick-start.mdx b/website/versioned_docs/version-3.4/01_introduction/quick-start.mdx index a26a0c83f..5fc914796 100644 --- a/website/versioned_docs/version-3.4/01_introduction/quick-start.mdx +++ b/website/versioned_docs/version-3.4/01_introduction/quick-start.mdx @@ -1,6 +1,7 @@ --- id: quick-start title: Quick start +slug: /quick-start description: Get started with the Apify SDK for Python by creating your first Actor and learning the basics. ---