docs: Update docs to use new 'Tag' UI feature on Dev Docs. (#3632)

* Update dfx-bootstrap.md * Update and rename dfx-build.md to dfx-build.mdx * Update and rename dfx-cache.md to dfx-cache.mdx * Update and rename dfx-canister.md to dfx-canister.mdx * Rename dfx-bootstrap.md to dfx-bootstrap.mdx * Update and rename dfx-cycles.md to dfx-cycles.mdx * Update and rename dfx-deploy.md to dfx-deploy.mdx * Update and rename dfx-deps.md to dfx-deps.mdx * Update and rename dfx-envars.md to dfx-envars.mdx * Update and rename dfx-generate.md to dfx-generate.mdx * Update and rename dfx-help.md to dfx-help.mdx * Update and rename dfx-identity.md to dfx-identity.mdx * Update and rename dfx-info.md to dfx-info.mdx * Update and rename dfx-ledger.md to dfx-ledger.mdx * Update and rename dfx-new.md to dfx-new.mdx * Update and rename dfx-nns.md to dfx-nns.mdx * Update and rename dfx-parent.md to dfx-parent.mdx * Update and rename dfx-ping.md to dfx-ping.mdx * Update and rename dfx-quickstart.md to dfx-quickstart.mdx * Update and rename dfx-replica.md to dfx-replica.mdx * Update and rename dfx-schema.md to dfx-schema.mdx * Update and rename dfx-sns.md to dfx-sns.mdx * Update dfx-nns.mdx * Update and rename dfx-start.md to dfx-start.mdx * Update and rename dfx-stop.md to dfx-stop.mdx * Update and rename dfx-upgrade.md to dfx-upgrade.mdx * Update and rename dfx-wallet.md to dfx-wallet.mdx * Update and rename index.md to index.mdx --------- Co-authored-by: Linwei Shang <[email protected]>
dfinity · Mar 5, 2024 · 0cfe2de · 0cfe2de
1 parent dd20e6f
commit 0cfe2de
Show file tree

Hide file tree

Showing 28 changed files with 136 additions and 29 deletions.
diff --git a/docs/cli-reference/dfx-bootstrap.md b/docs/cli-reference/dfx-bootstrap.md
diff --git a/docs/cli-reference/dfx-bootstrap.mdx b/docs/cli-reference/dfx-bootstrap.mdx
@@ -0,0 +1,7 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
+# dfx bootstrap {#_dfx_bootstrap}
+
+<MarkdownChipRow labels={["Reference"]} />
+
+> **NOTE**: The bootstrap command has been removed. Please use the [dfx start](./dfx-start.mdx) command instead.
diff --git a/docs/cli-reference/dfx-build.md → docs/cli-reference/dfx-build.mdx b/docs/cli-reference/dfx-build.md → docs/cli-reference/dfx-build.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx build
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx build` command to compile your program into a WebAssembly module that can be deployed on the IC. You can use this command to compile all of the programs that are defined for a project in the project’s `dfx.json` configuration file or a specific canister.
 
 Note that you can only run this command from within the project directory structure. For example, if your project name is `hello_world`, your current working directory must be the `hello_world` top-level project directory or one of its subdirectories.

diff --git a/docs/cli-reference/dfx-cache.md → docs/cli-reference/dfx-cache.mdx b/docs/cli-reference/dfx-cache.md → docs/cli-reference/dfx-cache.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx cache
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx cache` command with flags and subcommands to manage the `dfx` version cache.
 
 The basic syntax for running `dfx cache` commands is:

diff --git a/docs/cli-reference/dfx-canister.md → docs/cli-reference/dfx-canister.mdx b/docs/cli-reference/dfx-canister.md → docs/cli-reference/dfx-canister.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx canister
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx canister` command with options and subcommands to manage canister operations and interaction with the
 Internet Computer or the local canister execution environment. In most cases, you use `dfx canister` subcommands after
 you compile a program to manage the canister lifecycle and to perform key tasks such as calling program functions.

diff --git a/docs/cli-reference/dfx-cycles.md → docs/cli-reference/dfx-cycles.mdx b/docs/cli-reference/dfx-cycles.md → docs/cli-reference/dfx-cycles.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx cycles
 
+<MarkdownChipRow labels={["Reference"]} />
+
 > **NOTE**: The cycles ledger is in development and the dfx cycles command is not expected to work on mainnet at this time.
 
 Use the `dfx cycles` command to manage cycles associated with an identity's principal.

diff --git a/docs/cli-reference/dfx-deploy.md → docs/cli-reference/dfx-deploy.mdx b/docs/cli-reference/dfx-deploy.md → docs/cli-reference/dfx-deploy.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx deploy
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx deploy` command to register, build, and deploy a dapp on the local canister execution environment, on the IC or on a specified testnet. By default, all canisters defined in the project `dfx.json` configuration file are deployed.
 
 This command simplifies the developer workflow by enabling you to run one command instead of running the following commands as separate steps:

diff --git a/docs/cli-reference/dfx-deps.md → docs/cli-reference/dfx-deps.mdx b/docs/cli-reference/dfx-deps.md → docs/cli-reference/dfx-deps.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx deps
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx deps` command with flags and subcommands to pull dependencies from the mainnet and deploy locally.
 
 The basic syntax for running `dfx deps` commands is:

diff --git a/docs/cli-reference/dfx-envars.md → docs/cli-reference/dfx-envars.mdx b/docs/cli-reference/dfx-envars.md → docs/cli-reference/dfx-envars.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # Environment variables
 
+<MarkdownChipRow labels={["Reference"]} />
+
 You can configure certain properties for your SDK execution environment using environment variables.
 
 This section lists the environment variables that are currently supported with examples of how to use them. In most cases, you can set environment variables for a session by executing an command in the terminal or by adding a line similar to the following to your `.profile` file:

diff --git a/docs/cli-reference/dfx-generate.md → docs/cli-reference/dfx-generate.mdx b/docs/cli-reference/dfx-generate.md → docs/cli-reference/dfx-generate.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx generate
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx generate` command to generate canister type declarations for supported programming languages. Currently, `dfx generate` supports four languages: Motoko, Candid, JavaScript, and TypeScript.
 
 You can use this command to generate type declarations for all canisters that are defined for a project in the project’s `dfx.json` configuration file or a specific canister.

diff --git a/docs/cli-reference/dfx-help.md → docs/cli-reference/dfx-help.mdx b/docs/cli-reference/dfx-help.md → docs/cli-reference/dfx-help.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx help
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use this command to view usage information for the `dfx` parent command or for any specified subcommand.
 
 ## Basic usage

diff --git a/docs/cli-reference/dfx-identity.md → docs/cli-reference/dfx-identity.mdx b/docs/cli-reference/dfx-identity.md → docs/cli-reference/dfx-identity.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx identity
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx identity` command with subcommands and flags to manage the identities used to execute commands and communicate with the IC or the local canister execution environment. Creating multiple user identities enables you to test user-based access controls.
 
 The basic syntax for running `dfx identity` commands is:

diff --git a/docs/cli-reference/dfx-info.md → docs/cli-reference/dfx-info.mdx b/docs/cli-reference/dfx-info.md → docs/cli-reference/dfx-info.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx info
 
+<MarkdownChipRow labels={["Reference"]} />
+
 ## Basic usage
 
 ``` bash

diff --git a/docs/cli-reference/dfx-ledger.md → docs/cli-reference/dfx-ledger.mdx b/docs/cli-reference/dfx-ledger.md → docs/cli-reference/dfx-ledger.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx ledger
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx ledger` command to interact with the ledger canister.
 
 This command can be used to make ICP utility token transactions from one canister to another, or top up canisters with cycles from ICP.

diff --git a/docs/cli-reference/dfx-new.md → docs/cli-reference/dfx-new.mdx b/docs/cli-reference/dfx-new.md → docs/cli-reference/dfx-new.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx new
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx new` command to create a new project for the IC. This command creates a default project structure with template files that you can modify to suit your dapp. You must specify the name of the project to you want to create.
 
 You can use the `--dry-run` option to preview the directories and files to be created without adding them to the file system.

diff --git a/docs/cli-reference/dfx-nns.md → docs/cli-reference/dfx-nns.mdx b/docs/cli-reference/dfx-nns.md → docs/cli-reference/dfx-nns.mdx
@@ -1,3 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
+# dfx nns
+
+<MarkdownChipRow labels={["Reference"]} />
+
 :::caution
 The `dfx nns` command is no longer part of dfx, and has now been turned into the dfx extension. In order to obtain it, please run `dfx extension install nns`.
 :::

diff --git a/docs/cli-reference/dfx-parent.md → docs/cli-reference/dfx-parent.mdx b/docs/cli-reference/dfx-parent.md → docs/cli-reference/dfx-parent.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx
 
+<MarkdownChipRow labels={["Reference"]} />
+
 The DFINITY command-line execution environment (`dfx`) is the primary tool for creating, deploying, and managing the
 dapps you develop for the IC.
 

diff --git a/docs/cli-reference/dfx-ping.md → docs/cli-reference/dfx-ping.mdx b/docs/cli-reference/dfx-ping.md → docs/cli-reference/dfx-ping.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx ping
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx ping` command to check connectivity to the IC or a testnet. This command enables you to verify that you can connect to the environment where you want to deploy to.
 
 To ping your local server, please note that you can only run this command from within the project directory structure. For example, if your project name is `hello_world`, your current working directory must be the `hello_world` top-level project directory or one of its subdirectories.

diff --git a/docs/cli-reference/dfx-quickstart.md → docs/cli-reference/dfx-quickstart.mdx b/docs/cli-reference/dfx-quickstart.md → docs/cli-reference/dfx-quickstart.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx quickstart
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx quickstart` command to perform initial one time setup for your identity and/or wallet. This command
 can be run anytime to repeat the setup process or to be used as an informational command, printing
 information about

diff --git a/docs/cli-reference/dfx-replica.md b/docs/cli-reference/dfx-replica.md
diff --git a/docs/cli-reference/dfx-replica.mdx b/docs/cli-reference/dfx-replica.mdx
@@ -0,0 +1,7 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
+# dfx replica
+
+<MarkdownChipRow labels={["Reference"]} />
+
+> **NOTE**: The replica command has been removed. Please use the [dfx start](./dfx-start.md) command instead.
diff --git a/docs/cli-reference/dfx-schema.md → docs/cli-reference/dfx-schema.mdx b/docs/cli-reference/dfx-schema.md → docs/cli-reference/dfx-schema.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx schema
 
+<MarkdownChipRow labels={["Reference"]} />
+
 The `dfx schema` command prints the schema for `dfx.json`.
 
 ## Basic usage

diff --git a/docs/cli-reference/dfx-sns.md → docs/cli-reference/dfx-sns.mdx b/docs/cli-reference/dfx-sns.md → docs/cli-reference/dfx-sns.mdx
@@ -1,3 +1,8 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
+# dfx sns
+
+<MarkdownChipRow labels={["Reference"]} />
 :::caution
 The `dfx sns` command is no longer part of dfx, and has now been turned into the dfx extension. In order to obtain it, please run `dfx extension install sns`.
 :::

diff --git a/docs/cli-reference/dfx-start.md → docs/cli-reference/dfx-start.mdx b/docs/cli-reference/dfx-start.md → docs/cli-reference/dfx-start.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx start
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx start` command to start a local canister execution environment and web server processes. This command enables you to deploy canisters to the local canister execution environment to test your dapps during development.
 
 By default, all local dfx projects will use this single local canister execution environment, and you can run `dfx start` and `dfx stop` from any directory.  See [Local Server Configuration](#local-server-configuration) and [Project-Specific Local Networks](#project-specific-local-networks) below for exceptions.

diff --git a/docs/cli-reference/dfx-stop.md → docs/cli-reference/dfx-stop.mdx b/docs/cli-reference/dfx-stop.md → docs/cli-reference/dfx-stop.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx stop
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx stop` command to stop the local canister execution environment processes that you currently have running on your computer. In most cases, you run the canister execution environment locally so that you can deploy canisters and test your dapps during development. To simulate the connection to the IC, these processes run continuously either in a terminal shell where you started them or the in the background until you stop or kill them.
 
 You can run this command from any directory unless you are working with a dfx.json project that defines a project-specific local network.  See [Local Server Configuration](dfx-start.md#local-server-configuration) for details.

diff --git a/docs/cli-reference/dfx-upgrade.md → docs/cli-reference/dfx-upgrade.mdx b/docs/cli-reference/dfx-upgrade.md → docs/cli-reference/dfx-upgrade.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx upgrade
 
+<MarkdownChipRow labels={["Reference"]} />
+
 > **NOTE**: The upgrade command has been removed.  Please use the [dfx version manager][dfxvm] instead.
 
 [dfxvm]: https://github.com/dfinity/dfxvm
diff --git a/docs/cli-reference/dfx-wallet.md → docs/cli-reference/dfx-wallet.mdx b/docs/cli-reference/dfx-wallet.md → docs/cli-reference/dfx-wallet.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # dfx wallet
 
+<MarkdownChipRow labels={["Reference"]} />
+
 Use the `dfx wallet` command with subcommands and flags to manage the cycles wallets of your identities and to send cycles to the wallets of other account cycles wallet canisters.
 
 The basic syntax for running the `dfx wallet` commands is:

diff --git a/docs/cli-reference/index.md → docs/cli-reference/index.mdx b/docs/cli-reference/index.md → docs/cli-reference/index.mdx
@@ -1,5 +1,9 @@
+import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
+
 # Command-line reference
 
+<MarkdownChipRow labels={["Reference"]} />
+
 The DFINITY command-line execution environment (`dfx`) is the primary tool for creating, deploying, and managing the dapps for the Internet Computer platform.
 
 You can use the `dfx` parent command with different flags and subcommands to perform different types of operations.
@@ -14,48 +18,48 @@ Depending on the subcommand, the options and flags you specify might apply to th
 
 When you have the SDK installed, you can use the following commands to specify the operation you want to perform. For reference information and examples that illustrate using these commands, select an appropriate command.
 
--   [dfx](./dfx-parent.md)
+-   [dfx](./dfx-parent.mdx)
 
--   [dfx bootstrap](./dfx-bootstrap.md)
+-   [dfx bootstrap](./dfx-bootstrap.mdx)
 
--   [dfx build](./dfx-build.md)
+-   [dfx build](./dfx-build.mdx)
 
--   [dfx cache](./dfx-cache.md)
+-   [dfx cache](./dfx-cache.mdx)
 
--   [dfx canister](./dfx-canister.md)
+-   [dfx canister](./dfx-canister.mdx)
 
--   [dfx cycles](./dfx-cycles.md)
+-   [dfx cycles](./dfx-cycles.mdx)
 
--   [dfx deploy](./dfx-deploy.md)
+-   [dfx deploy](./dfx-deploy.mdx)
 
--   [dfx deps](./dfx-deps.md)
+-   [dfx deps](./dfx-deps.mdx)
 
--   [dfx help](./dfx-help.md)
+-   [dfx help](./dfx-help.mdx)
 
--   [dfx identity](./dfx-identity.md)
+-   [dfx identity](./dfx-identity.mdx)
 
--   [dfx info](./dfx-info.md)
+-   [dfx info](./dfx-info.mdx)
 
--   [dfx ledger](./dfx-ledger.md)
+-   [dfx ledger](./dfx-ledger.mdx)
 
--   [dfx new](./dfx-new.md)
+-   [dfx new](./dfx-new.mdx)
 
--   [dfx nns](./dfx-nns.md)
+-   [dfx nns](./dfx-nns.mdx)
 
--   [dfx ping](./dfx-ping.md)
+-   [dfx ping](./dfx-ping.mdx)
 
--   [dfx quickstart](./dfx-quickstart.md)
+-   [dfx quickstart](./dfx-quickstart.mdx)
 
--   [dfx replica](./dfx-replica.md)
+-   [dfx replica](./dfx-replica.mdx)
 
--   [dfx schema](./dfx-schema.md)
+-   [dfx schema](./dfx-schema.mdx)
 
--   [dfx sns](./dfx-sns.md)
+-   [dfx sns](./dfx-sns.mdx)
 
--   [dfx start](./dfx-start.md)
+-   [dfx start](./dfx-start.mdx)
 
--   [dfx stop](./dfx-stop.md)
+-   [dfx stop](./dfx-stop.mdx)
 
--   [dfx upgrade](./dfx-upgrade.md)
+-   [dfx upgrade](./dfx-upgrade.mdx)
 
--   [dfx wallet](./dfx-wallet.md)
+-   [dfx wallet](./dfx-wallet.mdx)