Skip to content

Commit 431f873

Browse files
committed
further changes
1 parent d984a71 commit 431f873

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ You should be able to open https://docs.apify.loc in your browser and run all th
105105
- info
106106
- caution
107107
- danger
108-
- Implement code tabs for multiple languages
108+
- Use code tabs for multiple languages
109109
- Include proper metadata in front matter
110110

111111
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
144144
Content lives in the following locations:
145145

146146
- 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
148148
- SDK docs: separate repositores
149149
- Client docs: separate repositories
150150
- CLI docs: separate repositories
@@ -153,7 +153,7 @@ Content lives in the following locations:
153153

154154
### Overview
155155

156-
The API reference documentation at docs.apify.com is built directly froum our OpenAPI specification. The source of truth for the API specification lives in 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 for the API specification lives in the `/apify-api/openapi` directory within [apify-docs](https://github.com/apify/apify-docs) repository.
157157

158158
### Setup requirements
159159

@@ -281,20 +281,20 @@ Add languages by adding new folders at the appropriate path level.
281281
1. Markdown:
282282

283283
```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
286286
```
287287

288288
2. Code:
289289

290290
```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
293293
```
294294

295295
3. Prose:
296296

297-
- Use Vale for content linting
297+
- Use [Vale](https://vale.sh/) for content linting
298298
- Configure exceptions in `accepts.txt`
299299

300300
## Pull request process
@@ -312,5 +312,4 @@ Add languages by adding new folders at the appropriate path level.
312312
## Additional resources
313313

314314
- [Docusaurus documentation](https://docusaurus.io/docs)
315-
- [OpenAPI specification]
316315
- [Vale style guide](https://vale.sh/docs)

0 commit comments

Comments
 (0)