docs: Replace oasis-node CLI with oasis CLI docs

oasisprotocol · May 26, 2023 · 5545f27 · 5545f27
1 parent b79f513
commit 5545f27
Show file tree

Hide file tree

Showing 15 changed files with 80 additions and 353 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -11,3 +11,6 @@
 [submodule "external/adrs"]
 	path = external/adrs
 	url = https://github.com/oasisprotocol/adrs
+[submodule "external/cli"]
+	path = external/cli
+	url = https://github.com/oasisprotocol/cli
diff --git a/README.md b/README.md
@@ -117,7 +117,7 @@ Markdown files hosted by this repository should:
   `../howto-use-wallet.md`.
   `../../../operators/set-up-your-node.md`
 
-Markdown files hosted by other Oasis repositories should:
+Symlinked Markdown files hosted by other Oasis repositories should:
 
 - reference markdown files in the same repository by a relative path e.g.
   `../howto-write-contract.md`.

diff --git a/docs/general/manage-tokens/README.mdx b/docs/general/manage-tokens/README.mdx
@@ -25,7 +25,7 @@ For your own security and peace of mind, please only use wallets that are listed
     findSidebarItem('/general/manage-tokens/terminology'),
     findSidebarItem('/general/manage-tokens/staking-and-delegating'),
     findSidebarItem('/general/manage-tokens/oasis-wallets/'),
-    findSidebarItem('/general/manage-tokens/advanced/oasis-cli-tools/'),
+    findSidebarItem('/general/manage-tokens/cli/'),
     findSidebarItem('/general/manage-tokens/holding-rose-tokens/custody-providers'),
     findSidebarItem('/general/manage-tokens/holding-rose-tokens/bitpie-wallet'),
     findSidebarItem('/general/manage-tokens/holding-rose-tokens/ledger-wallet'),

diff --git a/...ge-tokens/advanced/oasis-cli-tools/deposit-withdraw-tokens-to-from-paratime.mdx b/...ge-tokens/advanced/oasis-cli-tools/deposit-withdraw-tokens-to-from-paratime.mdx
diff --git a/docs/general/manage-tokens/advanced/oasis-cli-tools/setup.md b/docs/general/manage-tokens/advanced/oasis-cli-tools/setup.md
@@ -11,10 +11,7 @@ To run a command that requires a connection to an online Oasis node (i.e. the `s
 
 Here are some examples of Oasis Node CLI commands that need a connection to an online Oasis node:
 
-* `oasis-node stake info`: Shows general staking information.
-* `oasis-node stake list`: Lists all accounts with positive balance.
-* `oasis-node stake account info`: Shows detailed information for an account.
-* `oasis-node consensus submit_tx`: Submits a pre-generated transaction to the network.
+
 
 ## Local commands
 

diff --git a/docs/general/manage-tokens/advanced/oasis-cli-tools/transfer-tokens.md b/docs/general/manage-tokens/advanced/oasis-cli-tools/transfer-tokens.md
@@ -82,7 +82,8 @@ Escrow Account:
   ...
 ```
 
-We can observe that both, the general account and the escrow account (actively bounded and debonding), have a balance of 0 tokens.
+We can observe that both, the general account and the escrow account (actively
+bounded and debonding), have a balance of 0 tokens.
 
 ## Generate a Transfer Transaction
 

diff --git a/docs/general/manage-tokens/cli b/docs/general/manage-tokens/cli
@@ -0,0 +1 @@
+../../../external/cli/docs
diff --git a/docs/general/manage-tokens/holding-rose-tokens/ledger-wallet.md b/docs/general/manage-tokens/holding-rose-tokens/ledger-wallet.md
@@ -158,4 +158,4 @@ Ledger is supported by the Oasis CLI. Follow the instructions in the
 [Nano S Plus]: https://support.ledger.com/hc/en-us/articles/4445777839901-Update-Ledger-Nano-S-Plus-firmware
 [BIP 39]: https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki
 [Oasis Wallets]: ../oasis-wallets/README.mdx
-[Oasis CLI Tools]: ../advanced/oasis-cli-tools/README.md
+[Oasis CLI Tools]: ../cli/README.md
diff --git a/docs/general/manage-tokens/how-to-transfer-rose-into-paratime.mdx b/docs/general/manage-tokens/how-to-transfer-rose-into-paratime.mdx
@@ -198,7 +198,7 @@ learn how to use Oasis CLI instead.
 
 :::
 
-[Oasis CLI]: advanced/oasis-cli-tools/deposit-withdraw-tokens-to-from-paratime.mdx
+[Oasis CLI]: cli/account.mdx
 
 ### Verifying ParaTime deposits and withdrawals
 
@@ -233,5 +233,5 @@ addresses, Token Transfers, Contract Calls, etc.), you have to use the
     findSidebarItem('/dapp/emerald/writing-dapps-on-emerald'),
     findSidebarItem('/dapp/sapphire/quickstart'),
     findSidebarItem('/dapp/cipher/'),
-    findSidebarItem('/general/manage-tokens/advanced/oasis-cli-tools/deposit-withdraw-tokens-to-from-paratime')
+    findSidebarItem('/general/manage-tokens/cli/account')
 ]} />
diff --git a/docs/node/run-your-node/paratime-node.mdx b/docs/node/run-your-node/paratime-node.mdx
@@ -179,7 +179,7 @@ No manual node registration is necessary.
 
 :::info
 
-ParaTime rewards for running the compute node will be sent to your entity address **inside the ParaTime**. To access the rewards on the consensus layer, you will need to withdraw them first. Read the [Deposit/Withdraw Tokens to/from ParaTime](../../general/manage-tokens/advanced/oasis-cli-tools/deposit-withdraw-tokens-to-from-paratime.mdx) chapter to learn more.
+ParaTime rewards for running the compute node will be sent to your entity address **inside the ParaTime**. To access the rewards on the consensus layer, you will need to withdraw them first. Read the [Deposit/Withdraw Tokens to/from ParaTime](../../general/manage-tokens/cli/account.mdx) chapter to learn more.
 
 :::
 

diff --git a/external/cli b/external/cli
-Original file line number
+Diff line change
@@ Expand Up / @@ -179,7 +179,7 @@ No manual node registration is necessary. @@
     :::info
-    ParaTime rewards for running the compute node will be sent to your entity address **inside the ParaTime**. To access the rewards on the consensus layer, you will need to withdraw them first. Read the [Deposit/Withdraw Tokens to/from ParaTime](../../general/manage-tokens/advanced/oasis-cli-tools/deposit-withdraw-tokens-to-from-paratime.mdx) chapter to learn more.
+    ParaTime rewards for running the compute node will be sent to your entity address **inside the ParaTime**. To access the rewards on the consensus layer, you will need to withdraw them first. Read the [Deposit/Withdraw Tokens to/from ParaTime](../../general/manage-tokens/cli/account.mdx) chapter to learn more.
     :::
@@ Expand Down @@