diff --git a/docs/cli-reference/dfx-bootstrap.md b/docs/cli-reference/dfx-bootstrap.md deleted file mode 100644 index 430750c36e..0000000000 --- a/docs/cli-reference/dfx-bootstrap.md +++ /dev/null @@ -1,3 +0,0 @@ -# dfx bootstrap {#_dfx_bootstrap} - -> **NOTE**: The bootstrap command has been removed. Please use the [dfx start](./dfx-start.md) command instead. diff --git a/docs/cli-reference/dfx-bootstrap.mdx b/docs/cli-reference/dfx-bootstrap.mdx new file mode 100644 index 0000000000..2580ce9c0a --- /dev/null +++ b/docs/cli-reference/dfx-bootstrap.mdx @@ -0,0 +1,7 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + +# dfx bootstrap {#_dfx_bootstrap} + + + +> **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 b/docs/cli-reference/dfx-build.mdx similarity index 97% rename from docs/cli-reference/dfx-build.md rename to docs/cli-reference/dfx-build.mdx index c1a1f8ba1e..0e58b8f43d 100644 --- a/docs/cli-reference/dfx-build.md +++ b/docs/cli-reference/dfx-build.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx build + + 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 b/docs/cli-reference/dfx-cache.mdx similarity index 97% rename from docs/cli-reference/dfx-cache.md rename to docs/cli-reference/dfx-cache.mdx index 1ecae7004b..6611e89c3e 100644 --- a/docs/cli-reference/dfx-cache.md +++ b/docs/cli-reference/dfx-cache.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx cache + + 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 b/docs/cli-reference/dfx-canister.mdx similarity index 99% rename from docs/cli-reference/dfx-canister.md rename to docs/cli-reference/dfx-canister.mdx index 7413928afa..c90c0d0ad3 100644 --- a/docs/cli-reference/dfx-canister.md +++ b/docs/cli-reference/dfx-canister.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx canister + + 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 b/docs/cli-reference/dfx-cycles.mdx similarity index 98% rename from docs/cli-reference/dfx-cycles.md rename to docs/cli-reference/dfx-cycles.mdx index 9f8903e11f..ea5211c056 100644 --- a/docs/cli-reference/dfx-cycles.md +++ b/docs/cli-reference/dfx-cycles.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx cycles + + > **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 b/docs/cli-reference/dfx-deploy.mdx similarity index 98% rename from docs/cli-reference/dfx-deploy.md rename to docs/cli-reference/dfx-deploy.mdx index a397c2acec..0cceb9b988 100644 --- a/docs/cli-reference/dfx-deploy.md +++ b/docs/cli-reference/dfx-deploy.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx deploy + + 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 b/docs/cli-reference/dfx-deps.mdx similarity index 96% rename from docs/cli-reference/dfx-deps.md rename to docs/cli-reference/dfx-deps.mdx index 6633352ecf..92a3b21bc3 100644 --- a/docs/cli-reference/dfx-deps.md +++ b/docs/cli-reference/dfx-deps.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx deps + + 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 b/docs/cli-reference/dfx-envars.mdx similarity index 97% rename from docs/cli-reference/dfx-envars.md rename to docs/cli-reference/dfx-envars.mdx index a75c466cc9..2c11d8b68d 100644 --- a/docs/cli-reference/dfx-envars.md +++ b/docs/cli-reference/dfx-envars.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # Environment variables + + 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 b/docs/cli-reference/dfx-generate.mdx similarity index 97% rename from docs/cli-reference/dfx-generate.md rename to docs/cli-reference/dfx-generate.mdx index 7d6bbf5c44..3efacc0de5 100644 --- a/docs/cli-reference/dfx-generate.md +++ b/docs/cli-reference/dfx-generate.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx generate + + 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 b/docs/cli-reference/dfx-help.mdx similarity index 86% rename from docs/cli-reference/dfx-help.md rename to docs/cli-reference/dfx-help.mdx index 01555ef93a..2dcf5cacca 100644 --- a/docs/cli-reference/dfx-help.md +++ b/docs/cli-reference/dfx-help.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx help + + 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 b/docs/cli-reference/dfx-identity.mdx similarity index 99% rename from docs/cli-reference/dfx-identity.md rename to docs/cli-reference/dfx-identity.mdx index 52185f3af4..4ebfe5a98b 100644 --- a/docs/cli-reference/dfx-identity.md +++ b/docs/cli-reference/dfx-identity.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx identity + + 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 b/docs/cli-reference/dfx-info.mdx similarity index 86% rename from docs/cli-reference/dfx-info.md rename to docs/cli-reference/dfx-info.mdx index 1c6f0eac40..0e0b9861b8 100644 --- a/docs/cli-reference/dfx-info.md +++ b/docs/cli-reference/dfx-info.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx info + + ## Basic usage ``` bash diff --git a/docs/cli-reference/dfx-ledger.md b/docs/cli-reference/dfx-ledger.mdx similarity index 99% rename from docs/cli-reference/dfx-ledger.md rename to docs/cli-reference/dfx-ledger.mdx index 128de6557e..b6c42c0802 100644 --- a/docs/cli-reference/dfx-ledger.md +++ b/docs/cli-reference/dfx-ledger.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx ledger + + 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 b/docs/cli-reference/dfx-new.mdx similarity index 97% rename from docs/cli-reference/dfx-new.md rename to docs/cli-reference/dfx-new.mdx index 32bde55cdf..50b7778240 100644 --- a/docs/cli-reference/dfx-new.md +++ b/docs/cli-reference/dfx-new.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx new + + 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 b/docs/cli-reference/dfx-nns.mdx similarity index 97% rename from docs/cli-reference/dfx-nns.md rename to docs/cli-reference/dfx-nns.mdx index 6c5368ce47..b4324f1c13 100644 --- a/docs/cli-reference/dfx-nns.md +++ b/docs/cli-reference/dfx-nns.mdx @@ -1,3 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + +# dfx nns + + + :::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 b/docs/cli-reference/dfx-parent.mdx similarity index 98% rename from docs/cli-reference/dfx-parent.md rename to docs/cli-reference/dfx-parent.mdx index d8f02c3461..a77ccc714c 100644 --- a/docs/cli-reference/dfx-parent.md +++ b/docs/cli-reference/dfx-parent.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx + + 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 b/docs/cli-reference/dfx-ping.mdx similarity index 91% rename from docs/cli-reference/dfx-ping.md rename to docs/cli-reference/dfx-ping.mdx index e31b8456f1..0b1288d871 100644 --- a/docs/cli-reference/dfx-ping.md +++ b/docs/cli-reference/dfx-ping.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx ping + + 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 b/docs/cli-reference/dfx-quickstart.mdx similarity index 94% rename from docs/cli-reference/dfx-quickstart.md rename to docs/cli-reference/dfx-quickstart.mdx index f0ae34e543..9528af5efa 100644 --- a/docs/cli-reference/dfx-quickstart.md +++ b/docs/cli-reference/dfx-quickstart.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx quickstart + + 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 deleted file mode 100644 index 054d193fa1..0000000000 --- a/docs/cli-reference/dfx-replica.md +++ /dev/null @@ -1,3 +0,0 @@ -# dfx replica - -> **NOTE**: The replica command has been removed. Please use the [dfx start](./dfx-start.md) command instead. \ No newline at end of file diff --git a/docs/cli-reference/dfx-replica.mdx b/docs/cli-reference/dfx-replica.mdx new file mode 100644 index 0000000000..9fe49a57ed --- /dev/null +++ b/docs/cli-reference/dfx-replica.mdx @@ -0,0 +1,7 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + +# dfx replica + + + +> **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 b/docs/cli-reference/dfx-schema.mdx similarity index 90% rename from docs/cli-reference/dfx-schema.md rename to docs/cli-reference/dfx-schema.mdx index 368ca92fb0..8835a7079f 100644 --- a/docs/cli-reference/dfx-schema.md +++ b/docs/cli-reference/dfx-schema.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx schema + + The `dfx schema` command prints the schema for `dfx.json`. ## Basic usage diff --git a/docs/cli-reference/dfx-sns.md b/docs/cli-reference/dfx-sns.mdx similarity index 96% rename from docs/cli-reference/dfx-sns.md rename to docs/cli-reference/dfx-sns.mdx index dea853072a..ac41838aba 100644 --- a/docs/cli-reference/dfx-sns.md +++ b/docs/cli-reference/dfx-sns.mdx @@ -1,3 +1,8 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + +# dfx sns + + :::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 b/docs/cli-reference/dfx-start.mdx similarity index 98% rename from docs/cli-reference/dfx-start.md rename to docs/cli-reference/dfx-start.mdx index 2ec382bf9d..61fde998f8 100644 --- a/docs/cli-reference/dfx-start.md +++ b/docs/cli-reference/dfx-start.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx start + + 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 b/docs/cli-reference/dfx-stop.mdx similarity index 94% rename from docs/cli-reference/dfx-stop.md rename to docs/cli-reference/dfx-stop.mdx index 72055e5ef4..d5e17a990f 100644 --- a/docs/cli-reference/dfx-stop.md +++ b/docs/cli-reference/dfx-stop.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx stop + + 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 b/docs/cli-reference/dfx-upgrade.mdx similarity index 58% rename from docs/cli-reference/dfx-upgrade.md rename to docs/cli-reference/dfx-upgrade.mdx index 5ecdbb0f8e..329eb4a331 100644 --- a/docs/cli-reference/dfx-upgrade.md +++ b/docs/cli-reference/dfx-upgrade.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx upgrade + + > **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 b/docs/cli-reference/dfx-wallet.mdx similarity index 99% rename from docs/cli-reference/dfx-wallet.md rename to docs/cli-reference/dfx-wallet.mdx index 542ff50e27..76653f38fe 100644 --- a/docs/cli-reference/dfx-wallet.md +++ b/docs/cli-reference/dfx-wallet.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # dfx wallet + + 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 b/docs/cli-reference/index.mdx similarity index 50% rename from docs/cli-reference/index.md rename to docs/cli-reference/index.mdx index d05b68d23a..c058e6d9f0 100644 --- a/docs/cli-reference/index.md +++ b/docs/cli-reference/index.mdx @@ -1,5 +1,9 @@ +import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; + # Command-line 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)