You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-9Lines changed: 8 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,7 +105,7 @@ You should be able to open https://docs.apify.loc in your browser and run all th
105
105
- info
106
106
- caution
107
107
- danger
108
-
- Implement code tabs for multiple languages
108
+
- Use code tabs for multiple languages
109
109
- Include proper metadata in front matter
110
110
111
111
Example of proper usage and formatting:
@@ -144,7 +144,7 @@ You should be able to open https://docs.apify.loc in your browser and run all th
144
144
Content lives in the following locations:
145
145
146
146
- Main content like Platform documentation & Academy: `/sources` directory
147
-
- API reference: Genereated from OpenAPI specs within `/apify-api` directory
147
+
- API reference: Generated from OpenAPI specs within `/apify-api` directory
148
148
- SDK docs: separate repositores
149
149
- Client docs: separate repositories
150
150
- CLI docs: separate repositories
@@ -153,7 +153,7 @@ Content lives in the following locations:
153
153
154
154
### Overview
155
155
156
-
The API reference documentation at docs.apify.com is built directly froum our OpenAPI specification. The source of truth forthe API specification livesin the `/apify-api`directowy within [apify-docs](https://github.com/apify/apify-docs) repository.
156
+
The API reference documentation at docs.apify.com is built directly froum our OpenAPI specification. The source of truth forthe API specification livesin the `/apify-api/openapi`directory within [apify-docs](https://github.com/apify/apify-docs) repository.
157
157
158
158
### Setup requirements
159
159
@@ -281,20 +281,20 @@ Add languages by adding new folders at the appropriate path level.
281
281
1. Markdown:
282
282
283
283
```bash
284
-
npm run lint:md
285
-
npm run lint:md:fix
284
+
npm run lint:md# Checks for any issues using markdownlint
285
+
npm run lint:md:fix # Applies fixes
286
286
```
287
287
288
288
2. Code:
289
289
290
290
```bash
291
-
npm run lint:code
292
-
npm run lint:code:fix
291
+
npm run lint:code# Checks .js & .ts files
292
+
npm run lint:code:fix # Applies fixes
293
293
```
294
294
295
295
3. Prose:
296
296
297
-
- Use Vale for content linting
297
+
- Use [Vale](https://vale.sh/)for content linting
298
298
- Configure exceptions in`accepts.txt`
299
299
300
300
## Pull request process
@@ -312,5 +312,4 @@ Add languages by adding new folders at the appropriate path level.
0 commit comments