File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -33,12 +33,22 @@ API_KEY=<API_KEY>
3333
3434## Dependencies
3535
36+ ::: warning
37+ Make sure you use [ Node.js v14] ( https://nodejs.org/download/release/v14.21.3/ ) before for this setup.
38+ :::
39+
3640Install needed dependencies with
3741
3842``` bash
3943yarn install
4044```
4145
46+ or (better)
47+
48+ ``` bash
49+ pnpm install
50+ ```
51+
4252## Release Instructions
4353
4454` TODO ` : Write instructions
@@ -50,32 +60,39 @@ Setup `asterics-docs` using the provided `docs` tools (cf. [DOCS Reference](#DOC
5060``` bash
5161# Initialize asterics-docs
5262$ yarn docs init
63+ $ pnpm run docs init
5364
5465# Deinitialize asterics-docs
5566$ yarn docs deinit
67+ $ pnpm run docs deinit
5668
5769# Setup docs folder
5870$ yarn docs setup
71+ $ pnpm run docs setup
5972```
6073
6174Change and edit files
6275
6376``` bash
6477# Show status
6578$ yarn docs status
79+ $ pnpm run docs status
6680```
6781
6882Update changes
6983
7084``` bash
7185# Add files for commit
7286$ yarn docs add < file| folder> [< file| folder> ...]
87+ $ pnpm run docs add < file| folder> [< file| folder> ...]
7388
7489# Commit files
7590$ yarn docs commit
91+ $ pnpm run docs commit
7692
7793# Push changes to origin
7894$ yarn docs push
95+ $ pnpm run docs push
7996```
8097
8198` NOTE ` :
You can’t perform that action at this time.
0 commit comments