Skip to content

Commit 65f4c72

Browse files
mtrunkatclaudeCopilotMarcel RbroCopilot
authored
docs: Fix copy using Dave's LLM style guide (#2339)
*TL;DR: I used @davidjohnbarton's Apify LLM styleguide against the whole documentation, and these are the fixes. ## Summary This PR standardizes punctuation and article usage across documentation files for improved consistency and readability. ## Key Changes - **Em dash to hyphen conversion**: Replaced em dashes (—) with hyphens (-) in various contexts throughout the documentation, particularly in lists and explanatory phrases - **Article standardization**: - Changed "our" to "the" when referring to tools, libraries, and services (e.g., "our universal scrapers" → "the universal scrapers", "our code templates" → "code templates") - Removed redundant articles before proper nouns and service names (e.g., "the Apify Console" → "Apify Console" in some contexts) - Changed "to use one of our API clients" → "using one of the API clients" - **Minor wording improvements**: - "ultimate flexibility" → "full flexibility" - "Ok" → "Okay" - Removed incomplete/trailing text in some sections ## Files Modified Changes span across multiple documentation sections: - Academy guides (web scraping basics, tutorials, build-and-publish) - Platform documentation (proxy, storage, actors, integrations, collaboration) - API documentation ## Notable Details - The changes maintain semantic meaning while improving consistency - Em dash to hyphen conversion makes the text more accessible and standardizes punctuation style - Article usage changes make the documentation more objective and less possessive in tone https://claude.ai/code/session_01Re3ixKeyNomxheSkJaD7aW --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Marcel Rbro <marcel.rbro@apify.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: mtrunkat <594801+mtrunkat@users.noreply.github.com> Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
1 parent a984531 commit 65f4c72

113 files changed

Lines changed: 242 additions & 245 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

sources/academy/ai/ai-agents.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ slug: /ai/ai-agents
1212

1313
AI agents are goal-oriented systems that make independent decisions. They interact with environments using predefined tools and workflows to automate complex tasks.
1414

15-
On Apify, AI agents are built as Actorsserverless cloud programs for web scraping, data processing, and AI deployment. Apify evolved from running scrapers in the cloud to supporting LLMs that follow predefined workflows with dynamically defined goals.
15+
On Apify, AI agents are built as Actors - serverless cloud programs for web scraping, data processing, and AI deployment. Apify evolved from running scrapers in the cloud to supporting LLMs that follow predefined workflows with dynamically defined goals.
1616

1717
## Prerequisites
1818

sources/academy/build-and-publish/actor-ideas/actor_validation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Examine current search results. Few quality results for a query like _download d
4343

4444
Many results or ads for _Instagram scraper_ means the market is proven but competitive. You'll need to differentiate.
4545

46-
Check keyword difficulty and domain authority. If difficulty is 70+ and top pages have 80+ domain authority with thousands of backlinksand Apify already has an official Actor with 100,000+ usersyou can't compete directly. Find an adjacent angle or specialization.
46+
Check keyword difficulty and domain authority. If difficulty is 70+ and top pages have 80+ domain authority with thousands of backlinks - and Apify already has an official Actor with 100,000+ users - you can't compete directly. Find an adjacent angle or specialization.
4747

4848
## Analyze Google Trends
4949

@@ -57,7 +57,7 @@ Watch for spikes. Sudden jumps from media coverage or viral moments usually don'
5757

5858
Beyond SEO data, go where your potential users are. Browse Reddit, Hacker News, Stack Overflow, X (Twitter), Discord, and Facebook groups. What problems are people discussing? What tools do they wish existed?
5959

60-
Document your findings. Note quotes and recurring themes like _Multiple marketers on Reddit want easy competitor pricing trackingno existing solution mentioned_. These insights complement your SEO data and help you speak your users' language.
60+
Document your findings. Note quotes and recurring themes like _Multiple marketers on Reddit want easy competitor pricing tracking - no existing solution mentioned_. These insights complement your SEO data and help you speak your users' language.
6161

6262
Zero discussion across multiple platforms over 4+ weeks means either no one cares about the problem or they've already solved it.
6363

@@ -78,7 +78,7 @@ You can also use tools like [F5Bot](https://f5bot.com/) or
7878

7979
### Q&A forums and Stack Overflow
8080

81-
Look for questions about doing the task manually. If thinking about a LinkedIn scraper, check Stack Overflow for questions like _How can I scrape LinkedIn profiles?_ Frequent questions or upvotes indicate many people trying to solve it without a good toolan opportunity for your Actor.
81+
Look for questions about doing the task manually. If thinking about a LinkedIn scraper, check Stack Overflow for questions like _How can I scrape LinkedIn profiles?_ Frequent questions or upvotes indicate many people trying to solve it without a good tool - an opportunity for your Actor.
8282

8383
Use the `site:` parameter:
8484

@@ -132,7 +132,7 @@ Fork and commit activity shows developers actively work with the technology. Hig
132132

133133
## Review Product Hunt launches
134134

135-
Study successful automation tool launches from the past 12-24 months on Product Hunt. Filter by _Browser Automation_ and _Automation tools_, then sort by upvotes. Note which taglines, value propositions, and features resonated. Products with 500+ upvotes validated somethingfigure out what worked.
135+
Study successful automation tool launches from the past 12-24 months on Product Hunt. Filter by _Browser Automation_ and _Automation tools_, then sort by upvotes. Note which taglines, value propositions, and features resonated. Products with 500+ upvotes validated something - figure out what worked.
136136

137137
## Research Apify Store
138138

@@ -152,17 +152,17 @@ If the market has 50+ Actors with strong leaders (Apify-maintained with 50,000+
152152

153153
## Scan the broader market
154154

155-
Do a general Google search for tools or services that solve your problem. Your competition might not be another Actorit could be a SaaS tool or API. If your idea is _monitor website uptime and screenshot changes_, established services probably exist.
155+
Do a general Google search for tools or services that solve your problem. Your competition might not be another Actor - it could be a SaaS tool or API. If your idea is _monitor website uptime and screenshot changes_, established services probably exist.
156156

157157
Note direct competitors: How do they price it? What audience do they target? Are users satisfied or complaining? This validates that people pay for the service and reveals gaps you can fill.
158158

159-
Understanding the competition helps you refine your unique valuewhether that's lower cost, better features, or targeting an underserved niche.
159+
Understanding the competition helps you refine your unique value - whether that's lower cost, better features, or targeting an underserved niche.
160160

161161
No existing solutions? Ask why. You might have found an untapped need, or it's a red flag (too difficult to implement, or the target website aggressively blocks scraping). Use your judgment.
162162

163163
## Get feedback from potential users
164164

165-
Reach out to people who match your target user profile. Building a real estate data Actor? Contact real estate analysts or agents (LinkedIn works well) and ask if a tool that does X would help them. Keep it informaldescribe the problem you're solving and ask if they'd use or pay for it.
165+
Reach out to people who match your target user profile. Building a real estate data Actor? Contact real estate analysts or agents (LinkedIn works well) and ask if a tool that does X would help them. Keep it informal - describe the problem you're solving and ask if they'd use or pay for it.
166166

167167
Direct feedback helps you:
168168

sources/academy/build-and-publish/actor-ideas/what_software_an_actor_can_be.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ The [Actor ideas](https://apify.com/ideas) page is where you can find inspiratio
160160

161161
1. _Visit_ [apify.com/ideas](https://apify.com/ideas) to find ideas that interest you. Look for ideas that align with your skills.
162162

163-
1. _Select an Actor idea_: Review the details and requirements. Check the statusif it's marked **Open to develop**, you can start building.
163+
1. _Select an Actor idea_: Review the details and requirements. Check the status - if it's marked **Open to develop**, you can start building.
164164

165165
1. _Build your Actor_: Develop your Actor based on the idea. You don't need to notify Apify during development.
166166

@@ -176,7 +176,7 @@ The [Actor ideas](https://apify.com/ideas) page is where you can find inspiratio
176176

177177
<!-- #### Multiple developers for one idea
178178
179-
Apify Store can host multiple Actors with similar functions. However, the "first come, first served" rule appliesthe first developer to claim an idea receives the **Completed** tag and a link from the Actor ideas page.
179+
Apify Store can host multiple Actors with similar functions. However, the "first come, first served" rule applies - the first developer to claim an idea receives the **Completed** tag and a link from the Actor ideas page.
180180
181181
Competition motivates developers to improve the code. You can still build the Actor, but differentiate with a unique set of features. -->
182182

sources/academy/build-and-publish/apify-store-basics/how_actor_monetization_works.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Also, remember that your Actor is a package deal with the Apify platform. All th
144144

145145
### Do research in Apify Store
146146

147-
Apify Store is like any other marketplace, so take a look at your competition there. Are you the first in your lane, or are there other similar tools? What makes yours stand out? Remember, your README is your first impression communicate your tool's benefits clearly and offer something unique. Competing with other developers is great, but collaborations can drive even better results 😉
147+
Apify Store is like any other marketplace, so take a look at your competition there. Are you the first in your lane, or are there other similar tools? What makes yours stand out? Remember, your README is your first impression - communicate your tool's benefits clearly and offer something unique. Competing with other developers is great, but collaborations can drive even better results 😉
148148

149149
Learn more about what makes a good readme here: [How to create an Actor README](/academy/actor-marketing-playbook/actor-basics/how-to-create-an-actor-readme)
150150

sources/academy/build-and-publish/apify-store-basics/how_store_works.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ A high number of monthly users indicates widespread trust and effective performa
9797

9898
Each Actor has an **Issues** tab in Apify Console and on the web. Here, users can open an issue (ticket) and engage in discussions with the Actor's creator, platform admins, and other users. The tab is ideal for asking questions, requesting new features, or providing feedback.
9999

100-
Since the **Issues** tab is public, the level of activity or lack thereof can be observed by potential users and may serve as an indicator of the Actor's reliability. A well-maintained Issues tab with prompt responses suggests an active and dependable Actor.
100+
Since the **Issues** tab is public, the level of activity - or lack thereof - can be observed by potential users and may serve as an indicator of the Actor's reliability. A well-maintained Issues tab with prompt responses suggests an active and dependable Actor.
101101

102102
Learn more about how to handle the [Issues tab](/academy/actor-marketing-playbook/interact-with-users/issues-tab)
103103

sources/academy/build-and-publish/apify-store-basics/how_to_create_actor_readme.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Before we dive in, a little disclaimer: you don't need your Apify README to fulf
2929

3030
Your Actor’s README has at least four functions:
3131

32-
1. _SEO_ - If your README is well-structured and includes important keywords both in headings and across the text it has a high chance of being noticed and promoted by Google. Organic search brings the most motivated type of potential users. If you win this game, you've won most of the SEO game.
32+
1. _SEO_ - If your README is well-structured and includes important keywords - both in headings and across the text - it has a high chance of being noticed and promoted by Google. Organic search brings the most motivated type of potential users. If you win this game, you've won most of the SEO game.
3333
2. _First impression_ - Your README is one of the first points of contact with a potential user. If you come across as convincing, clear, and reassuring it could be the factor that will make a user try your Actor for their task.
3434
3. _Extended instruction_ - The README is also the space that explains specific complex input settings. For example, special formatting of the input, any coding-related, or extended functions. Of course, you could put that all in a blog post as well, but the README should be their first point of contact.
3535
4. _Support_ - Your users come back to the README when they face issues. Use it as a space to let them know that's where they can find links to the tutorials if they run into issues, describe common troubleshooting techniques, share tricks, or warn you about bugs.
@@ -56,7 +56,7 @@ Your Actor + the Apify platform. They come as a package. Don't forget to flaunt
5656

5757
:::
5858

59-
Imagine if there was a solution that is identical to yours but without the platform advantages such as monitoring, access to API, scheduling, possibility of integrations, proxy rotation. Now, if that tool suddenly gained all those advantages it would surely make a selling point out of it. This is how you should be thinking about your tool as a solution boosted by the Apify platform. Don't ever forget that advantage.
59+
Imagine if there was a solution that is identical to yours but without the platform advantages such as monitoring, access to API, scheduling, possibility of integrations, proxy rotation. Now, if that tool suddenly gained all those advantages it would surely make a selling point out of it. This is how you should be thinking about your tool - as a solution boosted by the Apify platform. Don't ever forget that advantage.
6060

6161
What data can [Actor] extract?
6262

@@ -108,7 +108,7 @@ If your datasets come out too complex and you want to save your users some scrol
108108

109109
### Other Actors
110110

111-
Don't forget to promote your other Actors. While our system for Actor recommendation works - you can see related Actors at the bottom of the README it only works within the same category or similar name. It won't recommend a completely different Actor from the same creator. Make sure to interconnect your work by taking the initiative yourself. You can mention your other Actors in a list or as a table.
111+
Don't forget to promote your other Actors. While Apify's system for Actor recommendation works - you can see related Actors at the bottom of the README - it only works within the same category or similar name. It won't recommend a completely different Actor from the same creator. Make sure to interconnect your work by taking the initiative yourself. You can mention your other Actors in a list or as a table.
112112

113113
### FAQ, disclaimers, and support
114114

@@ -125,7 +125,7 @@ Here are just a few things we usually push to the FAQ section.
125125
- mentioning the Issues tab and highlighting that you're open for feedback and collecting feedback
126126
- mentioning being open to creating a custom solution based on the current one and showing a way to contact you
127127
- interlinking
128-
- mentioning the possibility of transferring data using an API API tab
128+
- mentioning the possibility of transferring data using an API - API tab
129129
- possibility for integrations
130130
- use cases for the data scraped, success stories exemplifying the use of data
131131

sources/academy/build-and-publish/apify-store-basics/importance_of_actor_url.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The right naming can propel or hinder the success of the Actor on Google Search.
2828

2929
### Brainstorming
3030

31-
What does your Actor do? Does it scrape, find, extract, automate, connect? Think of these when you are looking for a name. You might already have a code name in mind, but it’s essential to ensure it stands out and is distinct from similar namesboth on Google and on Apify Store.
31+
What does your Actor do? Does it scrape, find, extract, automate, connect? Think of these when you are looking for a name. You might already have a code name in mind, but it’s essential to ensure it stands out and is distinct from similar names - both on Google and on Apify Store.
3232

3333
### Matching URL and name
3434

sources/academy/build-and-publish/apify-store-basics/name_your_actor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Your Actor's name should be _40-50 characters_ long. You can change your Actor n
3737

3838
### Actor name vs. SEO name
3939

40-
There's an option to step away from your Actor's name for the sake of search engine optimization the Actor SEO name. The Actor name and Actor SEO name serve different purposes:
40+
There's an option to step away from your Actor's name for the sake of search engine optimization - the Actor SEO name. The Actor name and Actor SEO name serve different purposes:
4141

4242
- _Actor name_: this is the name visible in Apify Store and Console. It should be easy for users to understand and quickly show what your Actor does. It’s about attracting users who browse the Store.
4343

sources/academy/build-and-publish/how-to-build/actor_bundles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Remember, bundles originated as customized solutions for specific use cases - th
6060

6161
This is also an opportunity to tell a story rather than just presenting a tool. Consider writing a blog post about how you created this tool, recording a video, or hosting a live webinar. If you go this route, it’s important to emphasize how the tool was created and what a technical feat it represents.
6262

63-
That said, don’t abandon SEO entirely. You can still capture some SEO value by referencing the bundle in the READMEs of the individual Actors that comprise it. For example, if a bundle collects reviews from multiple platforms, potential users are likely to search for review scrapers for each specific platformGoogle Maps reviews scraper, Tripadvisor reviews scraper, Booking reviews scraper, etc. These keywords may not lead directly to your review scraping bundle, but they can guide users to the individual scrapers, where you can then present the bundle as a more comprehensive solution.
63+
That said, don’t abandon SEO entirely. You can still capture some SEO value by referencing the bundle in the READMEs of the individual Actors that comprise it. For example, if a bundle collects reviews from multiple platforms, potential users are likely to search for review scrapers for each specific platform - Google Maps reviews scraper, Tripadvisor reviews scraper, Booking reviews scraper, etc. These keywords may not lead directly to your review scraping bundle, but they can guide users to the individual scrapers, where you can then present the bundle as a more comprehensive solution.
6464

6565
---
6666

0 commit comments

Comments
 (0)