Skip to content

Commit 2b493b4

Browse files
docs: Quick Start improvement - structure
1 parent 671b7b1 commit 2b493b4

File tree

2 files changed

+32
-17
lines changed

2 files changed

+32
-17
lines changed

sources/platform/actors/development/quick_start/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ For these languages, you can also [choose from many code templates](https://apif
3636

3737
You can develop Actor in two ways:
3838

39-
### Option 1: local Development
39+
### Option 1: Local Development
4040

4141
Develop your Actor locally in your IDE and only deploy to the Apify platform when it is production ready.
4242

sources/platform/actors/development/quick_start/start_locally.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,30 +32,45 @@ apify create
3232

3333
The Apify CLI will prompt you to:
3434

35-
1. _Name your Actor_: Enter a descriptive name for your Actor, such as `your-actor-name`
36-
1. _Choose a programming language_: Select the language you want to use for your Actor (JavaScript, TypeScript, or Python).
37-
1. _Select a development template_: Choose a template from the list of available options.
35+
1. Name your Actor: Enter a descriptive name for your Actor, such as `your-actor-name`.
36+
1. Choose a programming language: Select the language you want to use for your Actor (JavaScript, TypeScript, or Python).
37+
1. Select a development template: Choose a template from the list of available options.
38+
:::info
39+
40+
If you’re unsure which template to use, browse the [full list of templates](https://apify.com/templates) with descriptions to find the best fit for your Actor.
41+
42+
:::
43+
1. After selecting the template, the Apify CLI will:
44+
- Create a `your-actor-name` directory with the boilerplate code.
45+
- Install all project dependencies.
46+
1. Navigate to your new Actor directory:
47+
```bash
48+
cd your-actor-name
49+
```
3850

39-
:::info
51+
## Step 2: Run your Actor
4052

41-
If you’re unsure which template to use, browse the [full list of templates]((https://apify.com/templates)) with descriptions to find the best fit for your Actor.
53+
- tbd (see the result as soon as possible)
4254

43-
:::
55+
## Step 3: Explore the Result
56+
57+
- tbd (see the result - AHA moment, I get data)
58+
- explain the "code"
4459

45-
![Creation](./images/actor-create.gif)
60+
## Step 4: Deploy your Actor
4661

47-
After selecting the template, the Apify CLI will:
62+
- tbd
4863

49-
- Create a `your-actor-name` directory with the boilerplate code.
50-
- Install all project dependencies
64+
## Step 5: It's time to build!
5165

52-
Now, you can navigate to the newly created Actor directory:
66+
- Encourage developers to edit actors, build interesting stuff, etc.
67+
- Optional...
5368

54-
```bash
55-
cd your-actor-name
56-
```
69+
## Next Steps
70+
71+
- tbd (deploy)
5772

58-
## Explore the source code in your editor
73+
<!-- ## Explore the source code in your editor
5974

6075
After creating your Actor, explore the source code in your preferred code editor, We'll use the `Crawlee + Puppeteer + Chrome` template code as an example, but all Actor templates follow a similar organizational pattern. The important directories and filer are:
6176
@@ -121,4 +136,4 @@ Once you are satisfied with your Actor, to deploy it to the Apify platform, foll
121136
122137
:::
123138
124-
By following these steps, you can seamlessly deploy your Actors to the Apify platform, enabling you to leverage its scalability, reliability, and advanced features for your web scraping and data processing projects.
139+
By following these steps, you can seamlessly deploy your Actors to the Apify platform, enabling you to leverage its scalability, reliability, and advanced features for your web scraping and data processing projects. -->

0 commit comments

Comments
 (0)