1818
1919<!-- vale off -->
20201 . Clone the repository
21- 2 . Run ` npm install `
22- 3 . Start development server: ` npm start`
21+ 2 . Run ` yarn `
22+ 3 . Start development server: ` yarn start`
2323<!-- vale on -->
2424
2525This will be enough to work on Platform, Academy and OpenAPI. If you want to work on the entire documentation set, you need to join them using nginx.
2626
2727#### Join all repositories with nginx
2828
29291 . Clone all the repositories
30- 2 . Run ` npm start:dev` instead of ` npm start` from the main repository
31- 3 . Run ` npm start -- --port <number>` to start Docusaurus instance on specific port, refer to the table for each repository port
30+ 2 . Run ` yarn start:dev` instead of ` yarn start` from the main repository
31+ 3 . Run ` yarn start -- --port <number>` to start Docusaurus instance on specific port, refer to the table for each repository port
3232
3333 | Repository| Port|
3434 | :---| :---|
@@ -155,12 +155,12 @@ The API reference documentation at [docs.apify.com](https://docs.apify.com/) is
155155
1561561. Install Node.js
1571572. Clone the repository
158- 3. Run `npm install `
158+ 3. Run `yarn `
159159
160160### Basic commands
161161
162- - `npm start` - Starts docs preview server including API reference
163- - `npm test` - Validates the definition
162+ - `yarn start` - Starts docs preview server including API reference
163+ - `yarn test` - Validates the definition
164164
165165### Adding new documentation
166166
@@ -246,7 +246,7 @@ Add languages by adding new folders at the appropriate path level.
246246# ### Submitting changes
247247
2482481. Make your changes following the guidelines above
249- 2. Test locally using provided npm commands
249+ 2. Test locally using provided `yarn` commands
2502503. Submit a pull request to the `main` branch
2512514. Ensure all CI checks pass
252252
@@ -258,8 +258,8 @@ Add languages by adding new folders at the appropriate path level.
258258
259259 ` ` ` bash
260260
261- npm install
262- npm start
261+ yarn
262+ yarn start
263263
264264 ` ` `
265265
@@ -268,7 +268,7 @@ Add languages by adding new folders at the appropriate path level.
268268 - Clone all documentation repositories
269269 - Configure nginx server
270270 - Update hosts file
271- - Use `npm start:dev`
271+ - Use `yarn start:dev`
272272
273273# # Quality check
274274
@@ -277,15 +277,15 @@ Add languages by adding new folders at the appropriate path level.
2772771. Markdown :
278278
279279 ` ` ` bash
280- npm run lint:md # Checks for any issues using markdownlint
281- npm run lint:md:fix # Applies fixes
280+ yarn lint:md # Checks for any issues using markdownlint
281+ yarn lint:md:fix # Applies fixes
282282 ` ` `
283283
2842842. Code :
285285
286286 ` ` ` bash
287- npm run lint:code # Checks .js & .ts files
288- npm run lint:code:fix # Applies fixes
287+ yarn lint:code # Checks .js & .ts files
288+ yarn lint:code:fix # Applies fixes
289289 ` ` `
290290
2912913. Prose :
0 commit comments