Commit 65f4c72
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
- sources
- academy
- ai
- build-and-publish
- actor-ideas
- apify-store-basics
- how-to-build
- interacting-with-users
- promoting-your-actor
- platform
- expert_scraping_with_apify/solutions
- getting_started
- tutorials
- api
- node_js
- webscraping
- advanced_web_scraping/crawling
- scraping_basics_javascript
- scraping_basics_legacy
- crawling
- data_extraction
- scraping_basics_python
- api
- platform
- actors
- development
- actor_definition
- output_schema
- deployment
- permissions
- programming_interface
- quick-start
- publishing
- monetize
- running
- collaboration
- organization_account
- console
- integrations
- actors
- ai
- programming
- webhooks
- workflows-and-notifications
- make
- n8n
- proxy
- storage
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| |||
Lines changed: 7 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
46 | | - | |
| 46 | + | |
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
| |||
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
60 | | - | |
| 60 | + | |
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
| |||
78 | 78 | | |
79 | 79 | | |
80 | 80 | | |
81 | | - | |
| 81 | + | |
82 | 82 | | |
83 | 83 | | |
84 | 84 | | |
| |||
132 | 132 | | |
133 | 133 | | |
134 | 134 | | |
135 | | - | |
| 135 | + | |
136 | 136 | | |
137 | 137 | | |
138 | 138 | | |
| |||
152 | 152 | | |
153 | 153 | | |
154 | 154 | | |
155 | | - | |
| 155 | + | |
156 | 156 | | |
157 | 157 | | |
158 | 158 | | |
159 | | - | |
| 159 | + | |
160 | 160 | | |
161 | 161 | | |
162 | 162 | | |
163 | 163 | | |
164 | 164 | | |
165 | | - | |
| 165 | + | |
166 | 166 | | |
167 | 167 | | |
168 | 168 | | |
| |||
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
160 | 160 | | |
161 | 161 | | |
162 | 162 | | |
163 | | - | |
| 163 | + | |
164 | 164 | | |
165 | 165 | | |
166 | 166 | | |
| |||
176 | 176 | | |
177 | 177 | | |
178 | 178 | | |
179 | | - | |
| 179 | + | |
180 | 180 | | |
181 | 181 | | |
182 | 182 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
144 | 144 | | |
145 | 145 | | |
146 | 146 | | |
147 | | - | |
| 147 | + | |
148 | 148 | | |
149 | 149 | | |
150 | 150 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
97 | 97 | | |
98 | 98 | | |
99 | 99 | | |
100 | | - | |
| 100 | + | |
101 | 101 | | |
102 | 102 | | |
103 | 103 | | |
| |||
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
| 32 | + | |
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
| |||
56 | 56 | | |
57 | 57 | | |
58 | 58 | | |
59 | | - | |
| 59 | + | |
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
| |||
108 | 108 | | |
109 | 109 | | |
110 | 110 | | |
111 | | - | |
| 111 | + | |
112 | 112 | | |
113 | 113 | | |
114 | 114 | | |
| |||
125 | 125 | | |
126 | 126 | | |
127 | 127 | | |
128 | | - | |
| 128 | + | |
129 | 129 | | |
130 | 130 | | |
131 | 131 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
| 40 | + | |
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
63 | | - | |
| 63 | + | |
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
| |||
0 commit comments