Skip to content

Commit 90caef7

Browse files
authored
docs: Update content and screenshots in development topics (#2411)
- Add new type of screenshots - Delete unnecessary images - Rewrite sections that accompany the updated screenshots
1 parent 87a5298 commit 90caef7

File tree

8 files changed

+325
-50
lines changed

8 files changed

+325
-50
lines changed

sources/platform/actors/development/quick-start/build_with_ai.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,9 @@ claude mcp add apify "https://mcp.apify.com/?tools=docs" -t http
133133

134134
## Provide context to assistants
135135

136-
Every page in the Apify documentation has a **Copy for LLM** button. You can use it to add additional context to your AI assistant, or even open the page in ChatGPT, Claude, or Perplexity and ask additional questions.
136+
Every page in the Apify documentation has a **Copy for LLM** button. Use it to add more context to your AI assistant, or even open the page in ChatGPT, Claude, or Perplexity and ask additional questions.
137137

138-
<img src={copyForAI} alt="Copy for LLM" width="250" />
138+
![Page from the Apify documentation with the Copy for LLM button highlighted](./images/copy-for-llm-button.svg)
139139

140140
## Use `/llms.txt` files
141141

Binary file not shown.
Binary file not shown.
Binary file not shown.

sources/platform/actors/development/quick-start/images/build-actor-in-web-ide.svg

Lines changed: 144 additions & 0 deletions
Loading

sources/platform/actors/development/quick-start/images/copy-for-llm-button.svg

Lines changed: 144 additions & 0 deletions
Loading
Binary file not shown.

sources/platform/actors/development/quick-start/start_web_ide.md

Lines changed: 35 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,31 @@ slug: /actors/development/quick-start/web-ide
88
import Tabs from '@theme/Tabs';
99
import TabItem from '@theme/TabItem';
1010

11-
## What you'll learn
1211

13-
This guide walks you through the full lifecycle of an Actor using the web IDE in Apify Console. You'll create an Actor from a code template, build it, configure its input, and run it in the cloud.
12+
This guide walks you through the full lifecycle of an Actor using the web IDE in Apify Console: create an Actor from a code template, build it, configure its input, and run it in the cloud.
1413

15-
### Prerequisites
14+
## Prerequisites
1615

17-
- An Apify account. [Sign up for a free account](https://console.apify.com/sign-up) on the Apify website.
16+
To complete this tutorial, you need an Apify account. If you don't have it yet, [sign up for free](https://console.apify.com/sign-up).
1817

19-
### Step 1: Create your Actor
18+
## Step 1: Create your Actor
2019

21-
Log in to [Apify Console](https://console.apify.com), navigate to [**My Actors**](https://console.apify.com/actors/development/my-actors), then click the **Develop new** button. You can also click the **Create** button on the Dashboard and select **Create Actor**.
20+
To create an Actor from a code template:
2221

23-
![Create Actor](./images/create-actor.png)
22+
1. Log in to [Apify Console](https://console.apify.com).
23+
1. In the left-side panel, go to **Development** > **My Actors**.
24+
1. Click **Develop new**.
25+
1. Under **Select a code template**, choose one of the available options. For this tutorial, let's use **Quick start: Crawlee + Cheerio**.
2426

25-
You'll see options to link a Git repository, select a code template, or push code with the Apify CLI.
27+
:::tip Explore Actor templates
2628

27-
Under **Select a code template**, you'll find quick-start templates for TypeScript, Python, and JavaScript. Click **Browse all templates** to see the full list. Choose the template that best suits your needs. For the following demo, we'll proceed with a **Crawlee + Cheerio** template.
28-
29-
:::info Explore Actor templates
30-
31-
Browse the [full list of templates](https://apify.com/templates) to find the best fit for your Actor.
29+
To find a template that best suits your needs, browse the [full list of templates](https://apify.com/templates).
3230

3331
:::
3432

35-
![Templates](./images/actor-templates.png)
36-
37-
After choosing the template, your Actor will be automatically named and you'll be redirected to its page.
33+
Once you choose the template, your Actor is automatically named and you're redirected to its page.
3834

39-
### Step 2: Explore the Actor
35+
## Step 2: Explore the Actor
4036

4137
The provided boilerplate code utilizes the [Apify SDK](https://docs.apify.com/sdk/js/) combined with [Crawlee](https://crawlee.dev/), Apify's popular open-source Node.js web scraping library.
4238

@@ -48,44 +44,35 @@ By default, the code crawls the [apify.com](https://apify.com) website, but you
4844

4945
:::
5046

51-
### Step 3: Build the Actor
52-
53-
To run your Actor, build it first. Click the **Build** button below the source code.
54-
55-
![Actor source code](./images/actor-source-code.png)
56-
57-
Once the build starts, the UI transitions to the **Last build** tab, showing build progress and Docker build logs.
47+
## Step 3: Build the Actor
5848

59-
![Actor build](./images/actor-build.png)
60-
61-
:::note Actor creation flow
62-
63-
The UI includes four tabs:
64-
65-
- **Code**
66-
- **Last build**
67-
- **Input**
68-
- **Last run**
69-
70-
This represents the Actor creation flow, where you first build the Actor from the source code. Once the build is successful, you can provide input parameters and initiate an Actor run.
71-
72-
:::
49+
The next step it to build the Actor:
7350

74-
### Step 4: Run the Actor
51+
1. Go to **Source** tab > **Code**.
52+
1. Click **Build**.
7553

76-
Once the Actor is built, you can look at its input, which consists of one field - **Start URL**, the URL where the crawling starts. Below the input, you can adjust the **Run options**:
54+
Once the build starts, you're redirected to the **Last build** tab. Here you can check the build progress and view Docker build logs.
7755

78-
- **Build**
79-
- **Timeout**
80-
- **Memory limit**
56+
![Source code of an Actor in the web IDE](./images/build-actor-in-web-ide.svg)
8157

82-
![Actor input](./images/actor-input.png)
58+
## Step 4: Run the Actor
8359

84-
To initiate an Actor run, click the **Start** button at the bottom of the page. Once the run is created, you can monitor its progress and view the log in real-time. The **Output** tab will display the results of the Actor's execution, which will be populated as the run progresses. You can abort the run at any time using the **Abort** button.
60+
Finally, it's time to run the Actor:
61+
<!-- vale off -->
62+
1. Go to **Source** tab > **Input**.
63+
1. Set the **Start URL** to the URL you want to crawl or use the default value.
64+
1. _(Optional)_ To customize the run, expand the **Run options** section. You can adjust the following options:
65+
- **Build** – select the build version to run.
66+
- **Timeout** – set the timeout for the run in seconds.
67+
- **Memory limit** – allocate the memory for the run. For details, see [Usage and resources](/platform/actors/running/usage-and-resources).
68+
- **Maximum cost per run**.
69+
1. Click **Start**.
70+
<!-- vale on -->
71+
Once the run starts, you can monitor its progress and view the logs in real-time. To view the results of the Actor's execution, go to the **Output** tab.
8572

86-
![Actor run](./images/actor-run.png)
73+
To stop the run, click **Abort**.
8774

88-
### Step 5: Pull the Actor
75+
## Step 5: Pull the Actor
8976

9077
To continue development locally, pull the Actor's source code to your machine.
9178

@@ -139,7 +126,7 @@ To pull your Actor:
139126

140127
You can find both by clicking on the Actor title at the top of the page, which will open a new window containing the Actor's unique name and ID.
141128
142-
### Step 6: It's time to iterate!
129+
## Step 6: It's time to iterate!
143130

144131
After pulling the Actor's source code to your local machine, you can modify and customize it to match your specific requirements. Leverage your preferred code editor or development environment to make the necessary changes and enhancements.
145132

0 commit comments

Comments
 (0)