docs: standardize shell commands in the docs (#1470)

FuelLabs · Dec 12, 2023 · 3f0c18f · 3f0c18f
1 parent 3669c1a
commit 3f0c18f
Show file tree

Hide file tree

Showing 29 changed files with 74 additions and 64 deletions.
diff --git a/.changeset/cuddly-days-wink.md b/.changeset/cuddly-days-wink.md
@@ -0,0 +1,6 @@
+---
+docs: standardize shell commands in the docs
+---
+
+Removed `yarn`, ensured all examples have two variations and tabularized
+examples.
diff --git a/apps/docs/src/getting-started.md b/apps/docs/src/getting-started.md
@@ -12,10 +12,6 @@ To begin, you need to add the `fuels` dependency to your project. You can do thi
 npm install fuels --save
 ```
 
-```sh [yarn]
-yarn add fuels
-```
-
 ```sh [pnpm]
 pnpm add fuels
 ```

diff --git a/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md b/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md
@@ -5,15 +5,15 @@
 First we install `fuels` to our project:
 
 ```console
-yarn add fuels
+pnpm add fuels
 ```
 
 ## Help
 
 A first glance at the docs:
 
 ```console
-$ yarn exec fuels typegen -h
+$ pnpm fuels typegen -h
 
 Usage: fuels typegen [options]
 
@@ -36,7 +36,7 @@ You can generate types for a Sway contract using the command below:
 <!-- gen_types:example:start -->
 
 ```console
-yarn exec fuels typegen -i ./abis/*-abi.json -o ./types
+pnpm fuels typegen -i ./abis/*-abi.json -o ./types
 ```
 
 <!-- gen_types:example:end -->
@@ -57,15 +57,15 @@ You can omit the `--contract` option here since it's the default.
 To generate types for a Sway script, use the `--script` flag:
 
 ```console
-yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --script
+pnpm fuels typegen -i ./abis/*-abi.json -o ./types --script
 ```
 
 ## Generating Types for Predicates
 
 To generate types for a Sway predicate, use the `--predicate` flag:
 
 ```console
-yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --predicate
+pnpm fuels typegen -i ./abis/*-abi.json -o ./types --predicate
 ```
 
 ---

diff --git a/apps/docs/src/guide/abi-typegen/using-generated-types.md b/apps/docs/src/guide/abi-typegen/using-generated-types.md
@@ -5,7 +5,7 @@
 After generating types via:
 
 ```console
-yarn exec fuels typegen -i ./abis/*-abi.json -o ./types
+pnpm fuels typegen -i ./abis/*-abi.json -o ./types
 ```
 
 We can use these files like so:
@@ -59,7 +59,7 @@ const contract = await MyContract__factory.deployContract(bytecode, wallet, {
 After generating types via:
 
 ```console
-yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --script
+pnpm fuels typegen -i ./abis/*-abi.json -o ./types --script
 ```
 
 We can use these files like so:
@@ -87,7 +87,7 @@ Consider the following predicate:
 Now, after generating types via:
 
 ```console
-yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --predicate
+pnpm fuels typegen -i ./abis/*-abi.json -o ./types --predicate
 ```
 
 We can use these files like so:

diff --git a/apps/docs/src/guide/cli/index.md b/apps/docs/src/guide/cli/index.md
@@ -30,10 +30,18 @@ my-fuel-dapp # NextJS app or similar
 
 Add it to your `my-fuel-dapp` project:
 
-```console
+::: code-group
+
+```console [npm]
 npm install fuels --save
 ```
 
+```console [pnpm]
+pnpm add fuels
+```
+
+:::
+
 ## Double-checking
 
 ```console

diff --git a/apps/docs/src/index.md b/apps/docs/src/index.md
@@ -34,18 +34,18 @@ Learn more about the Fuel Ecosystem.
 
 ## Install
 
-#### YARN
+::: code-group
 
-```sh
-yarn add fuels
+```sh [pnpm]
+pnpm add fuels
 ```
 
-#### NPM
-
-```sh
+```sh [npm]
 npm install fuels --save
 ```
 
+:::
+
 ## Import
 
 <!-- TODO: stop using hard-coded snippets -->

diff --git a/packages/abi-coder/README.md b/packages/abi-coder/README.md
@@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 ### Installation
 
 ```sh
-yarn add @fuel-ts/abi-coder
+pnpm add @fuel-ts/abi-coder
 # or
 npm add @fuel-ts/abi-coder
 ```
@@ -35,7 +35,7 @@ npm add @fuel-ts/abi-coder
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/abi-typegen/README.md b/packages/abi-typegen/README.md
@@ -22,9 +22,9 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/abi-typeg
 ## Installation
 
 ```sh
-yarn add @fuel-ts/abi-typegen
+pnpm add @fuel-ts/abi-typegen
 # or
-npm add @fuel-ts/abi-typegen
+nppnpmm add @fuel-ts/abi-typegen
 ```
 
 ## Help
@@ -76,7 +76,7 @@ import { ProgramTypeEnum, runTypegen } from "@fuel-ts/abi-typegen";
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/address/README.md b/packages/address/README.md
@@ -23,7 +23,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/types/add
 ### Installation
 
 ```sh
-yarn add @fuel-ts/address
+pnpm add @fuel-ts/address
 # or
 npm add @fuel-ts/address
 ```
@@ -33,7 +33,7 @@ npm add @fuel-ts/address
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/contract/README.md b/packages/contract/README.md
@@ -23,7 +23,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/contracts
 ### Installation
 
 ```sh
-yarn add @fuel-ts/contract
+pnpm add @fuel-ts/contract
 # or
 npm add @fuel-ts/contract
 ```
@@ -33,7 +33,7 @@ npm add @fuel-ts/contract
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/crypto/README.md b/packages/crypto/README.md
@@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 ### Installation
 
 ```sh
-yarn add @fuel-ts/crypto
+pnpm add @fuel-ts/crypto
 # or
 npm add @fuel-ts/crypto
 ```
@@ -35,7 +35,7 @@ npm add @fuel-ts/crypto
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/errors/README.md b/packages/errors/README.md
@@ -27,7 +27,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 ### Installation
 
 ```sh
-yarn add @fuel-ts/errors
+pnpm add @fuel-ts/errors
 # or
 npm add @fuel-ts/errors
 ```

diff --git a/packages/hasher/README.md b/packages/hasher/README.md
@@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 ### Installation
 
 ```sh
-yarn add @fuel-ts/hasher
+pnpm add @fuel-ts/hasher
 # or
 npm add @fuel-ts/hasher
 ```
@@ -35,7 +35,7 @@ npm add @fuel-ts/hasher
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/hdwallet/README.md b/packages/hdwallet/README.md
@@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 ### Installation
 
 ```sh
-yarn add @fuel-ts/hdwallet
+pnpm add @fuel-ts/hdwallet
 # or
 npm add @fuel-ts/hdwallet
 ```
@@ -35,7 +35,7 @@ npm add @fuel-ts/hdwallet
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/interfaces/README.md b/packages/interfaces/README.md
@@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 ### Installation
 
 ```sh
-yarn add @fuel-ts/interfaces
+pnpm add @fuel-ts/interfaces
 # or
 npm add @fuel-ts/interfaces
 ```
@@ -35,7 +35,7 @@ npm add @fuel-ts/interfaces
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/math/README.md b/packages/math/README.md
@@ -27,7 +27,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 ### Installation
 
 ```sh
-yarn add @fuel-ts/math
+pnpm add @fuel-ts/math
 # or
 npm add @fuel-ts/math
 ```
@@ -37,7 +37,7 @@ npm add @fuel-ts/math
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/merkle/README.md b/packages/merkle/README.md
@@ -30,7 +30,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 ### Installation
 
 ```sh
-yarn add @fuel-ts/merkle
+pnpm add @fuel-ts/merkle
 # or
 npm add @fuel-ts/merkle
 ```
@@ -40,7 +40,7 @@ npm add @fuel-ts/merkle
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/mnemonic/README.md b/packages/mnemonic/README.md
@@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 ### Installation
 
 ```sh
-yarn add @fuel-ts/mnemonic
+pnpm add @fuel-ts/mnemonic
 # or
 npm add @fuel-ts/mnemonic
 ```
@@ -35,7 +35,7 @@ npm add @fuel-ts/mnemonic
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/predicate/README.md b/packages/predicate/README.md
@@ -23,7 +23,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/predicate
 ### Installation
 
 ```sh
-yarn add @fuel-ts/predicate
+pnpm add @fuel-ts/predicate
 # or
 npm add @fuel-ts/predicate
 ```
@@ -33,7 +33,7 @@ npm add @fuel-ts/predicate
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/program/README.md b/packages/program/README.md
@@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 ### Installation
 
 ```sh
-yarn add @fuel-ts/program
+pnpm add @fuel-ts/program
 # or
 npm add @fuel-ts/program
 ```
@@ -35,7 +35,7 @@ npm add @fuel-ts/program
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```

diff --git a/packages/providers/README.md b/packages/providers/README.md
@@ -23,7 +23,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/providers
 ### Installation
 
 ```sh
-yarn add @fuel-ts/providers
+pnpm add @fuel-ts/providers
 # or
 npm add @fuel-ts/providers
 ```
@@ -33,7 +33,7 @@ npm add @fuel-ts/providers
 Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:
 
 ```sh
-yarn add fuels
+pnpm add fuels
 # or
 npm add fuels
 ```