From 021a65fd7bd53f614765d36bfe383789e2f3db23 Mon Sep 17 00:00:00 2001 From: Marcel Rebro Date: Wed, 12 Nov 2025 16:27:27 +0100 Subject: [PATCH 1/4] docs: improve intro page --- docs/index.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/index.md b/docs/index.md index c365e9df6..545016fd1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,23 +1,24 @@ --- -title: Overview +title: Introduction +description: An introduction to Apify CLI, a command-line interface for creating, developing, building, and running Apify Actors and managing the Apify cloud platform. +sidebar_label: Introduction --- -Apify command-line interface (Apify CLI) helps you create, develop, build and run -[Apify Actors](https://apify.com/actors), -and manage the Apify cloud platform from any computer. +Apify command-line interface (Apify CLI) helps you create, develop, build and run [Apify Actors](https://apify.com/actors), and manage the Apify cloud platform from any computer. -Apify Actors are cloud programs that can perform arbitrary web scraping, automation or data processing job. -They accept input, perform their job and generate output. -While you can develop Actors in an online IDE directly in the [Apify web application](https://console.apify.com/), -for complex projects it is more convenient to develop Actors locally on your computer -using Apify SDK -and only push the Actors to the Apify cloud during deployment. -This is where the Apify CLI comes in. +Apify Actors are cloud programs that can perform arbitrary web scraping, automation or data processing job. They accept input, perform their job and generate output. The Apify CLI enables you to develop Actors locally on your computer using your preferred code editor, version control system, and development tools. This approach gives you full control over your development environment, makes it easier to work on complex projects, and allows you to leverage the [Apify SDK](https://github.com/apify/apify-sdk-js) with all its powerful features. When you're ready, simply push your Actor to the Apify cloud for deployment. -:::note Run Actors in Docker +:::note Actor Development Environment -Actors running on the Apify platform are executed in Docker containers, so with an appropriate `Dockerfile` -you can build your Actors in any programming language. -However, we recommend using JavaScript/Node.js and Python, for which we provide most libraries and support. +Actors running on the Apify platform are executed in Docker containers, so with an appropriate `Dockerfile` you can build your Actors in any programming language. However, we recommend using JavaScript/Node.js and Python, for which we provide most libraries and support. ::: + +## Learn more + +Learn everything you need to use the Apify CLI effectively: + +- Learn how to [install](./installation.md) the CLI on your system +- Get started with your [first Actor project](./quick-start.md) +- See the complete [reference of all CLI commands](./reference.md) and options +- Find [solutions to common issues](./troubleshooting.md) From 17a0c31a71d16e16927adcdbfd97f9bead4be5ff Mon Sep 17 00:00:00 2001 From: Marcel Rebro Date: Thu, 13 Nov 2025 11:36:52 +0100 Subject: [PATCH 2/4] docs: change intro to overview --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 545016fd1..13628fcd2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,7 @@ --- -title: Introduction +title: Apify CLI overview description: An introduction to Apify CLI, a command-line interface for creating, developing, building, and running Apify Actors and managing the Apify cloud platform. -sidebar_label: Introduction +sidebar_label: Overview --- Apify command-line interface (Apify CLI) helps you create, develop, build and run [Apify Actors](https://apify.com/actors), and manage the Apify cloud platform from any computer. From e657afb410dba30a4acd94f02706dc7b824c95f5 Mon Sep 17 00:00:00 2001 From: Marcel Rebro Date: Tue, 25 Nov 2025 13:18:35 +0100 Subject: [PATCH 3/4] docs: review suggestions --- docs/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index 13628fcd2..e8fe090a3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,11 +4,11 @@ description: An introduction to Apify CLI, a command-line interface for creating sidebar_label: Overview --- -Apify command-line interface (Apify CLI) helps you create, develop, build and run [Apify Actors](https://apify.com/actors), and manage the Apify cloud platform from any computer. +Apify command-line interface (Apify CLI) helps you create, develop, build and run [Apify Actors](https://apify.com/actors), and manage the Apify platform from any computer. -Apify Actors are cloud programs that can perform arbitrary web scraping, automation or data processing job. They accept input, perform their job and generate output. The Apify CLI enables you to develop Actors locally on your computer using your preferred code editor, version control system, and development tools. This approach gives you full control over your development environment, makes it easier to work on complex projects, and allows you to leverage the [Apify SDK](https://github.com/apify/apify-sdk-js) with all its powerful features. When you're ready, simply push your Actor to the Apify cloud for deployment. +Apify Actors are cloud programs that can perform arbitrary web scraping, automation or data processing job. They accept input, perform their job and generate output. The Apify CLI enables you to develop Actors locally on your computer using your preferred code editor, version control system, and development tools. This approach gives you full control over your development environment, makes it easier to work on complex projects, and allows you to leverage the [Apify SDK](https://github.com/apify/apify-sdk-js) with all its powerful features. When you're ready, simply push your Actor to the Apify platform for deployment. -:::note Actor Development Environment +:::note Actor development environment Actors running on the Apify platform are executed in Docker containers, so with an appropriate `Dockerfile` you can build your Actors in any programming language. However, we recommend using JavaScript/Node.js and Python, for which we provide most libraries and support. From 272b353dcbf29cc3a0a588cbf5d20c48ea57e9f0 Mon Sep 17 00:00:00 2001 From: Marcel Rebro Date: Fri, 28 Nov 2025 14:18:03 +0100 Subject: [PATCH 4/4] apply review suggestions --- docs/index.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index e8fe090a3..c18eabb60 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,11 +6,23 @@ sidebar_label: Overview Apify command-line interface (Apify CLI) helps you create, develop, build and run [Apify Actors](https://apify.com/actors), and manage the Apify platform from any computer. -Apify Actors are cloud programs that can perform arbitrary web scraping, automation or data processing job. They accept input, perform their job and generate output. The Apify CLI enables you to develop Actors locally on your computer using your preferred code editor, version control system, and development tools. This approach gives you full control over your development environment, makes it easier to work on complex projects, and allows you to leverage the [Apify SDK](https://github.com/apify/apify-sdk-js) with all its powerful features. When you're ready, simply push your Actor to the Apify platform for deployment. +## What are Apify Actors? + +Actors are cloud programs that can perform arbitrary web scraping, automation or data processing job. They accept input, perform their job and generate output. + +## Why use Apify CLI? + +The Apify CLI enables you to develop Actors locally on your computer using your preferred tools: + +- Your favorite code editor +- Version control system +- Development tools and workflows + +This gives you full control over your development environment and makes it easier to work on complex projects. You can leverage the [Apify SDK](https://github.com/apify/apify-sdk-js) with all its powerful features, then push your Actor to the Apify platform for deployment when ready. :::note Actor development environment -Actors running on the Apify platform are executed in Docker containers, so with an appropriate `Dockerfile` you can build your Actors in any programming language. However, we recommend using JavaScript/Node.js and Python, for which we provide most libraries and support. +Actors run in Docker containers on the Apify platform. With an appropriate `Dockerfile`, you can build Actors in any programming language. We recommend JavaScript/Node.js and Python, for which we have the most comprehensive libraries and support. :::