Skip to content

Commit d1bf2db

Browse files
committed
make vale happy & reformat store basics & actor basics section
reformat store basics & actor basics sections to fit within docs and take advantage of docusaurus add screenshots fix descriptions make vale happy fix issues with mdlint
1 parent cc2d01b commit d1bf2db

18 files changed

+178
-154
lines changed

.github/styles/config/vocabularies/Docs/accept.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
\bApify\b(?:-\w+)?
22
@apify\.com
3-
Actor(s)?
43
SDK(s)
54
[Ss]torages
65
Crawlee
@@ -106,5 +105,7 @@ subwoofer
106105
captcha
107106
captchas
108107
deduplicating
108+
reindexes
109+
READMEs
109110

110111
jQuery

sources/academy/platform/get_most_of_actors/actor_basics/actor_description_seo_description.md

Lines changed: 54 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -10,115 +10,117 @@ Learn about Actor description and meta description. Where to set them and best p
1010

1111
---
1212

13-
## What is an Actor description?
13+
## What is an Actor description
1414

15-
First impressions are important, especially when it comes to tools. Actor descriptions are the first connections the potential users have with your Actor. There are two kinds of descriptions you can set: _regular description_ (in Apify Store) and _SEO description_ (on Google search), along with their respective names: regular name and SEO name.
15+
First impressions are important, especially when it comes to tools. Actor descriptions are the first connections the potential users have with your Actor. You can set two kinds of descriptions: _regular description_ (in Apify Store) and _SEO description_ (on Google search), along with their respective names: regular name and SEO name.
1616

17-
💡 Apify tip: you can change descriptions and names as many times as you want.
17+
:::tip
1818

19-
## Regular description vs. SEO description
20-
21-
💡 Actor name and description are the text bits visible in Store.
19+
You can change descriptions and names as many times as you want.
2220

23-
Name: 40-50 characters
24-
Description: 300 characters
21+
:::
2522

26-
💡 SEO name and SEO description are the text bits visible on Google.
23+
## Regular description vs. SEO description
2724

28-
Name: 40-50 characters
29-
Description: 145-155 characters
25+
| | Actor description & name | SEO description & name |
26+
|---|---|---|
27+
| Name lenght | 40-50 characters | 40-50 characters |
28+
| Description lenght | 300 characters | 145-155 characters |
29+
| Visibility | Visible in the Store | Visible on Google |
3030

3131
### Description & Actor name
3232

3333
Actor description is what users see on the Actor's web page in Apify Store, along with the Actor's name and URL. When creating an Actor description, a “warm” visitor experience is prioritized (more on that later).
3434

35-
<!-- TODO screenshot -->
35+
![actor name & description](images/actor-description-name.png)
3636

3737
Actor description is also present in Apify Console and across Apify Store.
3838

39-
<!-- TODO Screenshot -->
39+
![actor description in store](images/actor-description-store.png)
4040

4141
### SEO description & SEO name
4242

4343
Actor SEO description is a tool description visible on Google. It is shorter and SEO-optimized (keywords matter here). When creating the SEO description, a “cold” visitor experience is prioritized.
4444

45-
<!-- TODO SCREENSHOT -->
45+
![seo description](images/seo_description.png)
4646

47-
So usually the way the potential user interacts with both these descriptions goes like this: SEO first, regular description second. So is there any benefit in them being different?
47+
Usually the way the potential user interacts with both these descriptions goes like this: SEO first, regular description second. Is there any benefit in them being different?
4848

49-
### Is there any benefit in description and meta description being different?
49+
### Is there any benefit in description and meta description being different
5050

5151
Different descriptions give you a chance to target different stages of user acquisition. And make sure the acquisition takes place.
5252

53-
SEO description (and SEO name) is targeting a “cold” potential user who knows nothing about your tool yet and just came across it on Google search. They’re searching to solve a problem or use case. The goal of the meta description is to convince that visitor to click on your tool's page among other similar search results on Google. While it's shorter, SEO description is also the space to SEO-optimize your language to the max to attract the most matching search intent.
53+
_SEO description (and SEO name)_ is targeting a “cold” potential user who knows nothing about your tool yet and just came across it on Google search. They’re searching to solve a problem or use case. The goal of the meta description is to convince that visitor to click on your tool's page among other similar search results on Google. While it's shorter, SEO description is also the space to SEO-optimize your language to the max to attract the most matching search intent.
5454

55-
Description (and name) is targeting a “warm” potential user who is already curious about your tool. They have clicked on the tool's page and have a few seconds to understand how complex the tool is and what it can do for them. So here you can forget SEO optimization and speak directly to the user. The regular description also has a longer character limit, which means you can expand on your Actor’s features.
55+
_Description (and name)_ is targeting a “warm” potential user who is already curious about your tool. They have clicked on the tool's page and have a few seconds to understand how complex the tool is and what it can do for them. Here you can forget SEO optimization and speak directly to the user. The regular description also has a longer character limit, which means you can expand on your Actor’s features.
5656

57-
📚 Learn more about search intent here: [SEO]
57+
Learn more about search intent here: [SEO](academy/get-most-of-actors/promote-your-actor/seo)
5858

5959
## Where can Actor descriptions be set
6060

6161
Both descriptions can be found and edited on the very right **Publication tab → Display information.** It has to be done separately for each Actor.
6262

63-
💡 Note that setting the SEO description and SEO name is optional. If not set, the description will just be duplicated.
63+
:::note
64+
65+
Setting the SEO description and SEO name is optional. If not set, the description will just be duplicated.
6466

65-
<!-- TODO 2 screenshots -->
67+
:::
6668

67-
Actor description specifically can also be quick-edited in this pop-up on the Actor's page in Apify Console. Open the **Actor's page**, then click on … in the top right corner, and choose ✎ **Edit name or description**. Then set the URL in the **Unique name** ✎ field and click **Save**.
69+
![changing seo name](images/changing__SEO_name.png)
6870

69-
<!-- TODO screenshot -->
71+
![changing actor name and seo name](images/changing_Actor_name_and_SEO_name.png)
72+
73+
Actor description specifically can also be quick-edited in this pop-up on the Actor's page in Apify Console. Open the **Actor's page**, then click on **** in the top right corner, and choose ✎ **Edit name or description**. Then set the URL in the **Unique name** ✎ field and click **Save**.
74+
75+
![changing actor description](images/change_Actor_description.png)
7076

7177
## Tips and recommendations on how to write descriptions
7278

7379
When writing a description, less is more. You only have a few seconds to capture attention and communicate what your Actor can do. To make the most of that time, follow these guidelines used by Apify (these apply to both types of descriptions):
7480

75-
### 1. Use variations and experiment 🔄
81+
### Use variations and experiment 🔄
7682

77-
- SEO name vs. regular name:
83+
- _SEO name vs. regular name_:
7884
- name: Airbnb Scraper
7985
- SEO name: Airbnb Data Scraper
80-
- Keywords on the web page:
81-
82-
Include variations, e.g. Airbnb API, Airbnb data, Airbnb data scraper, Airbnb rentals, Airbnb listings
83-
86+
- _Keywords on the web page_:<br/>
87+
Include variations, e.g. Airbnb API, Airbnb data, Airbnb data scraper, Airbnb rentals, Airbnb listings
8488
- No-code scraping tool to extract Airbnb data: host info, prices, dates, location, and reviews.
8589
- Scrape Airbnb listings without official Airbnb API!
86-
- Scraping/automation process variations:
87-
88-
Use terms, e.g. crawl, crawler, scraping tool, finder, scraper, data extraction tool, extract data, get data
89-
90+
- _Scraping/automation process variations_:<br/>
91+
Use terms, e.g. crawl, crawler, scraping tool, finder, scraper, data extraction tool, extract data, get data
9092
- Scrape XYZ data, scraped data, data scraper, data crawler.
9193

92-
### 2. Choose how to start your sentences 📝
94+
### Choose how to start your sentences 📝
9395

94-
- Noun-first (descriptive):
96+
- _Noun-first (descriptive)_:
9597
- Data extraction tool to extract Airbnb data: host info, prices, dates, location, and reviews.
96-
- Imperative-first (motivating):
98+
- _Imperative-first (motivating)_:
9799
- Try a free web scraping tool to extract Airbnb data: host info, prices, dates, location, and reviews.
98100

99101

100-
### 3. Keep it short and SEO-focused ✂️
102+
### Keep it short and SEO-focused ✂️
101103

102-
- Be concise and direct: clearly state what your Actor does. Avoid unnecessary fluff and boilerplate text.
104+
- _Be concise and direct_: clearly state what your Actor does. Avoid unnecessary fluff and boilerplate text.
103105
- ✅ Scrapes job listings from Indeed and gathers...
104106
-*This Actor scrapes job listings from Indeed in order to gather...
105-
- Optimize for search engines: include popular keywords related to your Actor’s functionality that users might search for.
107+
- _Optimize for search engines_: include popular keywords related to your Actor’s functionality that users might search for.
106108
- ✅ This Indeed scraper helps you collect job data efficiently. Use the tool to gather...
107109
- ❌ This tool will search through job listings on Indeed and offers you...
108110

109111

110-
### 4. List the data your Actor works with 📝
112+
### List the data your Actor works with 📝
111113

112114
- Data extraction tool to extract Airbnb data: host info, prices, dates, location, and reviews.
113115
- Get hashtags, usernames, mentions, URLs, comments, images, likes, locations without the official Instagram API.
114116

115-
### 5. Use keywords or the language of the target website 🗣️
117+
### Use keywords or the language of the target website 🗣️
116118

117119
- Extract data from hundreds of Airbnb home rentals in seconds.
118-
- Extract data from chosen tiktoks. Just add a TikTok URL and get TikTok video and profile data: URLs, numbers of shares, followers, hashtags, hearts, video, and music metadata.
120+
- Extract data from chosen tik-toks. Just add a TikTok URL and get TikTok video and profile data: URLs, numbers of shares, followers, hashtags, hearts, video, and music metadata.
119121
- Scrape Booking with this hotels scraper and get data about accommodation on Booking.com.
120122

121-
### 6. Highlight your strong suits 🌟
123+
### Highlight your strong suits 🌟
122124

123125
- Ease of use, no coding, user-friendly:
124126
- Easy scraping tool to extract Airbnb data.
@@ -133,26 +135,26 @@ When writing a description, less is more. You only have a few seconds to capture
133135
- Avoid ending lists with etc.
134136
- Consider adding relevant emojis for visual appeal.
135137

136-
### 7. Break it down 🔠
138+
### Break it down 🔠
137139

138-
Descriptions typically fit into 2-3 sentences. Don't try to jam everything into one. Examples:
140+
Descriptions typically fit into 2-3 sentences. Don't try to jam everything into one.
139141

140-
1. Scrape whole cities or extract data from hundreds of Airbnb rentals in seconds.
142+
Examples:
141143

144+
1. Scrape whole cities or extract data from hundreds of Airbnb rentals in seconds.
142145
1. Extract host information, addresses, locations, prices, availability, stars, reviews, images, and host/guest details.
143-
144146
1. Export scraped data, run the scraper via API, schedule and monitor runs, or integrate with other tools.
145147

146148
## FAQ
147-
148-
### Can the Actor's meta description and description be the same?
149+
<!-- markdownlint-disable MD001 -->
150+
#### Can the Actor's meta description and description be the same
149151

150152
Yes, they can, as long as they have the same (shorter) length (under 150 characters). But they can also be different, there's no harm in that.
151153

152-
### How different can description and meta description be?
154+
#### How different can description and meta description be
153155

154156
They can be vastly different and target different angles of your Actor. You can experiment by setting up different SEO descriptions for a period of time and seeing if the click-through rate rises.
155157

156-
### I set a custom SEO description but Google doesn't show it. What could be wrong?
158+
#### I set a custom SEO description but Google doesn't show it
157159

158-
⚠️ Sometimes Google picks up a part of the README as the SEO description. It's heavily dependent on the search query. Sometimes what you see on Google might look differently compared to how you set the SEO description. It's all a part of how Google customizes search results.
160+
Sometimes Google picks up a part of the README as the SEO description. It's heavily dependent on the search query. Sometimes what you see on Google might look differently compared to how you set the SEO description. It's all a part of how Google customizes search results.

sources/academy/platform/get_most_of_actors/actor_basics/actors-and-emojis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Actors & emojis
3-
description: Discover how emojis can elevate your Actors by grabbing attention, simplifying navigation, and enhancing clarity. Learn the art of using emojis effectively to improve user experience and engagement on the Apify Store.
3+
description: Discover how emojis can elevate your Actors by grabbing attention, simplifying navigation, and enhancing clarity. Improve user experience and engagement on Apify Store.
44
sidebar_position: 5
55
category: apify platform
66
slug: /get-most-of-actors/actor-basics/actors-and-emojis

0 commit comments

Comments
 (0)