From baae15c16633776eae8135f511932f1646018186 Mon Sep 17 00:00:00 2001 From: Linwei Shang Date: Thu, 15 Jan 2026 10:53:46 -0500 Subject: [PATCH 1/4] chore: Release 0.31.0-beta.0 (#4465) Signed-off-by: Linwei Shang --- Cargo.lock | 2 +- public/manifest.json | 3 ++- src/dfx/Cargo.toml | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 3cdc7d2503..3caba540db 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1619,7 +1619,7 @@ checksum = "abd57806937c9cc163efc8ea3910e00a62e2aeb0b8119f1793a978088f8f6b04" [[package]] name = "dfx" -version = "0.30.1" +version = "0.31.0-beta.0" dependencies = [ "actix", "aes-gcm", diff --git a/public/manifest.json b/public/manifest.json index 50f8cc9641..9304b3552e 100644 --- a/public/manifest.json +++ b/public/manifest.json @@ -85,6 +85,7 @@ "0.29.0", "0.29.1", "0.29.2", - "0.30.1" + "0.30.1", + "0.31.0-beta.0" ] } diff --git a/src/dfx/Cargo.toml b/src/dfx/Cargo.toml index 02501c19fa..e0752ac54e 100644 --- a/src/dfx/Cargo.toml +++ b/src/dfx/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "dfx" -version = "0.30.1" +version = "0.31.0-beta.0" authors.workspace = true edition.workspace = true repository.workspace = true From 441f0eb43f9ab80447f6e32c8683acbeb003794a Mon Sep 17 00:00:00 2001 From: Linwei Shang Date: Thu, 22 Jan 2026 10:56:20 -0500 Subject: [PATCH 2/4] chore: Release 0.31.0-beta.1 (#4467) Signed-off-by: Linwei Shang --- Cargo.lock | 2 +- public/manifest.json | 3 ++- src/dfx/Cargo.toml | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index bff53fcd7d..c1c1590b16 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1619,7 +1619,7 @@ checksum = "abd57806937c9cc163efc8ea3910e00a62e2aeb0b8119f1793a978088f8f6b04" [[package]] name = "dfx" -version = "0.31.0-beta.0" +version = "0.31.0-beta.1" dependencies = [ "actix", "aes-gcm", diff --git a/public/manifest.json b/public/manifest.json index c72f6e1e40..c9d401f97d 100644 --- a/public/manifest.json +++ b/public/manifest.json @@ -87,6 +87,7 @@ "0.29.2", "0.30.1", "0.30.2", - "0.31.0-beta.0" + "0.31.0-beta.0", + "0.31.0-beta.1" ] } diff --git a/src/dfx/Cargo.toml b/src/dfx/Cargo.toml index 14e1ed7428..4c59ccc3b7 100644 --- a/src/dfx/Cargo.toml +++ b/src/dfx/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "dfx" -version = "0.31.0-beta.0" +version = "0.31.0-beta.1" authors.workspace = true edition.workspace = true repository.workspace = true From 17743e4b337550ed9f9439189599fe6d75f9e90d Mon Sep 17 00:00:00 2001 From: Linwei Shang Date: Mon, 2 Mar 2026 17:41:00 -0500 Subject: [PATCH 3/4] chore: Release 0.31.0 (#4485) --- Cargo.lock | 2 +- public/manifest.json | 3 ++- src/dfx/Cargo.toml | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 11d4b4a9a3..b6756495b6 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1619,7 +1619,7 @@ checksum = "abd57806937c9cc163efc8ea3910e00a62e2aeb0b8119f1793a978088f8f6b04" [[package]] name = "dfx" -version = "0.31.0-beta.1" +version = "0.31.0" dependencies = [ "actix", "aes-gcm", diff --git a/public/manifest.json b/public/manifest.json index c9d401f97d..cc5e52dd8a 100644 --- a/public/manifest.json +++ b/public/manifest.json @@ -88,6 +88,7 @@ "0.30.1", "0.30.2", "0.31.0-beta.0", - "0.31.0-beta.1" + "0.31.0-beta.1", + "0.31.0" ] } diff --git a/src/dfx/Cargo.toml b/src/dfx/Cargo.toml index 4c59ccc3b7..e5e49e02fa 100644 --- a/src/dfx/Cargo.toml +++ b/src/dfx/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "dfx" -version = "0.31.0-beta.1" +version = "0.31.0" authors.workspace = true edition.workspace = true repository.workspace = true From b2c7ad17d6499907569d95f23836dc9b4812cf10 Mon Sep 17 00:00:00 2001 From: Ian Blenke Date: Wed, 4 Mar 2026 14:07:26 -0500 Subject: [PATCH 4/4] fix: fix formatting and broken anchors in CLI reference documentation - dfx-killall.mdx: Fix incorrect page title (was "dfx stop", now "dfx killall") - dfx-cache.mdx: Fix broken anchor links in command table - dfx-nns.mdx: Fix broken anchor links in command table and inline reference - dfx-sns.mdx: Fix broken anchor links in command table, add missing bash language tag on code block - dfx-completion.mdx: Fix trailing dash in table header separator - dfx-cycles.mdx: Fix malformed table in redeem-faucet-coupon arguments - dfx-wallet.mdx: Fix all malformed tables (missing pipe delimiters on separator rows) across command table, options, arguments, and flags sections Co-Authored-By: Claude Opus 4.6 --- CHANGELOG.md | 6 ++ docs/cli-reference/dfx-cache.mdx | 4 +- docs/cli-reference/dfx-completion.mdx | 2 +- docs/cli-reference/dfx-cycles.mdx | 6 +- docs/cli-reference/dfx-killall.mdx | 2 +- docs/cli-reference/dfx-nns.mdx | 6 +- docs/cli-reference/dfx-sns.mdx | 8 +-- docs/cli-reference/dfx-wallet.mdx | 80 +++++++++++++-------------- 8 files changed, 60 insertions(+), 54 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e1daded19e..b61515f3fa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ # UNRELEASED +## Fixes + +### fix: fix formatting and broken anchors in CLI reference documentation + +Fixed incorrect page title in `dfx-killall.mdx`, broken anchor references in command tables for `dfx cache`, `dfx nns`, and `dfx sns`, malformed markdown tables in `dfx-wallet.mdx`, `dfx-cycles.mdx`, and `dfx-completion.mdx`, and a missing code block language tag in `dfx-sns.mdx`. + ## Dependencies ### Motoko diff --git a/docs/cli-reference/dfx-cache.mdx b/docs/cli-reference/dfx-cache.mdx index ea347195be..3cc5d1873b 100644 --- a/docs/cli-reference/dfx-cache.mdx +++ b/docs/cli-reference/dfx-cache.mdx @@ -19,8 +19,8 @@ Depending on the `dfx cache` subcommand you specify, additional arguments, optio | [`delete`](#delete) | Deletes the specified version of `dfx` from the local cache. | | `help` | Displays usage information message for the `dfx cache` command. | | [`install`](#install) | Installs the specified version of `dfx` from the local cache. | -| [`list`](#_dfx_cache_list) | Lists the versions of `dfx` currently installed and used in current projects. | -| [`show`](#_dfx_cache_show) | Show the path of the cache used by this version of the `dfx` executable. | +| [`list`](#dfx-cache-list) | Lists the versions of `dfx` currently installed and used in current projects. | +| [`show`](#dfx-cache-show) | Show the path of the cache used by this version of the `dfx` executable. | To view usage information for a specific subcommand, specify the subcommand and the `--help` flag. For example, to see usage information for `dfx cache delete`, you can run the following command: diff --git a/docs/cli-reference/dfx-completion.mdx b/docs/cli-reference/dfx-completion.mdx index fc267d3e6b..96e1257812 100644 --- a/docs/cli-reference/dfx-completion.mdx +++ b/docs/cli-reference/dfx-completion.mdx @@ -23,7 +23,7 @@ and `zsh`. The default value is `bash`. You can use the following option with the `dfx completion` command. -| Option | Description -| +| Option | Description | |-----------------------|-------------------------------------| | `--bin-name ` | Name of the command. Only needed if referring to `dfx` by another name, such as with an alias. Default `dfx`. | diff --git a/docs/cli-reference/dfx-cycles.mdx b/docs/cli-reference/dfx-cycles.mdx index ea3c066691..09f96ea549 100644 --- a/docs/cli-reference/dfx-cycles.mdx +++ b/docs/cli-reference/dfx-cycles.mdx @@ -217,9 +217,9 @@ dfx cycles redeem-faucet-coupon Use the following necessary argument with the `dfx cycles redeem-faucet-coupon` command. -|Argument |Description -----------|-------------- -|`` | The coupon code to redeem at the faucet.| +| Argument | Description | +|----------|-------------| +| `` | The coupon code to redeem at the faucet. | ### Flags diff --git a/docs/cli-reference/dfx-killall.mdx b/docs/cli-reference/dfx-killall.mdx index 9d519b1663..d1c529255f 100644 --- a/docs/cli-reference/dfx-killall.mdx +++ b/docs/cli-reference/dfx-killall.mdx @@ -1,6 +1,6 @@ import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow"; -# dfx stop +# dfx killall diff --git a/docs/cli-reference/dfx-nns.mdx b/docs/cli-reference/dfx-nns.mdx index d9436c571c..bea223acb4 100644 --- a/docs/cli-reference/dfx-nns.mdx +++ b/docs/cli-reference/dfx-nns.mdx @@ -25,8 +25,8 @@ Depending on the `dfx nns` subcommand you specify, additional arguments, options | Command | Description | |-------------------------------------|-------------------------------------------------------------------------------| -| [`import`](#_dfx_nns_import) | Adds the NNS canisters to the local `dfx.json` as remote canisters. | -| [`install`](#_dfx_nns_install) | Deploys NNS canisters to the local development environment. | +| [`import`](#dfx-nns-import) | Adds the NNS canisters to the local `dfx.json` as remote canisters. | +| [`install`](#dfx-nns-install) | Deploys NNS canisters to the local development environment. | | `help` | Displays usage information message for a specified subcommand. | To view usage information for a specific subcommand, specify the subcommand and the `--help` flag. For example, to see usage information for `dfx nns install`, you can run the following command: @@ -125,7 +125,7 @@ Two accounts in the local ledger is initialized with ICP that can be used for te To use ICP on the command line: -1. Start `dfx` and install the NNS, as described in [`install`](#_dfx_nns_install). +1. Start `dfx` and install the NNS, as described in [`install`](#dfx-nns-install). 2. Put this secret key into a file called `ident-1.pem`: diff --git a/docs/cli-reference/dfx-sns.mdx b/docs/cli-reference/dfx-sns.mdx index cb1f40ebd1..27bbeeb97f 100644 --- a/docs/cli-reference/dfx-sns.mdx +++ b/docs/cli-reference/dfx-sns.mdx @@ -22,9 +22,9 @@ Depending on the `dfx sns` subcommand you specify, additional arguments, options | Command | Description | |-------------------------------------|-------------------------------------------------------------------------------| -| [`create`](#_dfx_sns_create) | Creates an SNS configuration template. | -| [`validate`](#_dfx_sns_validate) | Checks whether the sns config file is valid. | -| [`deploy`](#_dfx_sns_deploy) | Deploys SNS canisters according to the local config. | +| [`create`](#dfx-sns-create) | Creates an SNS configuration template. | +| [`validate`](#dfx-sns-validate) | Checks whether the sns config file is valid. | +| [`deploy`](#dfx-sns-deploy) | Deploys SNS canisters according to the local config. | | `help` | Displays usage information message for a specified subcommand. | To view usage information for a specific subcommand, specify the subcommand and the `--help` flag. For example, to see usage information for `dfx sns validate`, you can run the following command: @@ -104,7 +104,7 @@ dfx sns deploy You can now verify that the sns canisters have been created. -``` +``` bash dfx canister info sns_root dfx canister info sns_ledger ``` diff --git a/docs/cli-reference/dfx-wallet.mdx b/docs/cli-reference/dfx-wallet.mdx index dc96b23793..69fe16090a 100644 --- a/docs/cli-reference/dfx-wallet.mdx +++ b/docs/cli-reference/dfx-wallet.mdx @@ -25,21 +25,21 @@ dfx wallet send --help For reference information and examples that illustrate using `dfx wallet` commands, select an appropriate command. -|Command |Description ----------|----------------------------------- -|[`add-controller`](#dfx-wallet-add-controller) | Add a controller using the selected identity's principal. | -|[`addresses`](#dfx-wallet-addresses)|Displays the address book of the cycles wallet.| -|[`authorize`](#dfx-wallet-authorize)|Authorize a custodian by principal for the selected identity's cycles wallet.| -|[`balance`](#dfx-wallet-balance)|Displays the cycles wallet balance of the selected identity. -|[`controllers`](#dfx-wallet-controllers) |Displays a list of the selected identity's cycles wallet controllers. -|[`custodians`](#dfx-wallet-custodians) |Displays a list of the selected identity's cycles wallet custodians. -|[`deauthorize`](#dfx-wallet-deauthorize) | Deauthorize a cycles wallet custodian using the custodian's principal. -|`help`|Displays a usage message and the help info for the given subcommand(s). -|[`name`](#dfx-wallet-name) |Returns the name of the cycles wallet if you've used the `dfx wallet set-name` command. -|[`remove-controller`](#dfx-wallet-remove-controller) |Removes a specified controller from the selected identity's cycles wallet. -|[`send`](#dfx-wallet-send) |Sends a specified amount of cycles from the selected identity's cycles wallet to another canister. -|[`set-name`](#dfx-wallet-set-name) |Specify a name for your cycles wallet. -|[`upgrade`](#dfx-wallet-upgrade) |Upgrade the cycles wallet's Wasm module to the current Wasm bundled with `dfx`. +| Command | Description | +|---------|-------------| +| [`add-controller`](#dfx-wallet-add-controller) | Add a controller using the selected identity's principal. | +| [`addresses`](#dfx-wallet-addresses) | Displays the address book of the cycles wallet. | +| [`authorize`](#dfx-wallet-authorize) | Authorize a custodian by principal for the selected identity's cycles wallet. | +| [`balance`](#dfx-wallet-balance) | Displays the cycles wallet balance of the selected identity. | +| [`controllers`](#dfx-wallet-controllers) | Displays a list of the selected identity's cycles wallet controllers. | +| [`custodians`](#dfx-wallet-custodians) | Displays a list of the selected identity's cycles wallet custodians. | +| [`deauthorize`](#dfx-wallet-deauthorize) | Deauthorize a cycles wallet custodian using the custodian's principal. | +| `help` | Displays a usage message and the help info for the given subcommand(s). | +| [`name`](#dfx-wallet-name) | Returns the name of the cycles wallet if you've used the `dfx wallet set-name` command. | +| [`remove-controller`](#dfx-wallet-remove-controller) | Removes a specified controller from the selected identity's cycles wallet. | +| [`send`](#dfx-wallet-send) | Sends a specified amount of cycles from the selected identity's cycles wallet to another canister. | +| [`set-name`](#dfx-wallet-set-name) | Specify a name for your cycles wallet. | +| [`upgrade`](#dfx-wallet-upgrade) | Upgrade the cycles wallet's Wasm module to the current Wasm bundled with `dfx`. | ## Using your wallet @@ -80,18 +80,18 @@ dfx wallet add-controller [option] [flag] You can use the following options with the `dfx canister call` command. -|Option |Description| ---------|------------| -|`--network` |Override the environment to connect to. By default, the local development environment is used. A valid URL (starting with `http:` or `https:`) can be specified here, e.g. "http://localhost:12345/" is a valid network name. +| Option | Description | +|--------|-------------| +| `--network` | Override the environment to connect to. By default, the local development environment is used. A valid URL (starting with `http:` or `https:`) can be specified here, e.g. "http://localhost:12345/" is a valid network name. | ### Arguments You can specify the following arguments for the `dfx wallet add-controller` command. -|Argument |Description -----------|------------- -|`controller` |Specifies the principal of the controller to add to the wallet. +| Argument | Description | +|----------|-------------| +| `controller` | Specifies the principal of the controller to add to the wallet. | ### Examples @@ -156,9 +156,9 @@ dfx wallet authorize [flag] Use the following necessary argument with the `dfx wallet authorize` command. -|Argument |Description -----------|-------- -|`` | Specify the principal of the identity you would like to add as a custodian to the selected identity's cycles wallet. +| Argument | Description | +|----------|-------------| +| `` | Specify the principal of the identity you would like to add as a custodian to the selected identity's cycles wallet. | ### Example @@ -188,9 +188,9 @@ dfx wallet balance You can use the following optional flags with the `dfx wallet balance` command. -|Flag |Description --------|--------- -|`--precise` |Displays the exact balance, without scaling to trillions of cycles. +| Flag | Description | +|------|-------------| +| `--precise` | Displays the exact balance, without scaling to trillions of cycles. | ### Examples @@ -278,9 +278,9 @@ dfx wallet deauthorize [flag] Use the following necessary argument with the `dfx wallet deauthorize` command. -|Argument |Description -----------|-------------- -|`` | Specify the principal of the custodian you want to remove. +| Argument | Description | +|----------|-------------| +| `` | Specify the principal of the custodian you want to remove. | ### Example @@ -366,18 +366,18 @@ dfx wallet [network] send [flag] You can use the following option with the `dfx wallet send` command. -|Option |Description ------------|---------- -|`--network` |Override the environment to connect to. By default, the local development environment is used. A valid URL (starting with `http:` or `https:`) can be specified here, e.g. "http://localhost:12345/" is a valid network name. +| Option | Description | +|--------|-------------| +| `--network` | Override the environment to connect to. By default, the local development environment is used. A valid URL (starting with `http:` or `https:`) can be specified here, e.g. "http://localhost:12345/" is a valid network name. | ### Arguments You must specify the following arguments for the `dfx wallet send` command. -|Argument |Description ------------|---------- -|`` |Specify the destination canister using its canister ID. -|`` |Specify the number of cycles to send. +| Argument | Description | +|----------|-------------| +| `` | Specify the destination canister using its canister ID. | +| `` | Specify the number of cycles to send. | ### Examples @@ -406,9 +406,9 @@ dfx wallet set-name [flag] You must specify the following arguments for the `dfx wallet set-name` command. -|Argument |Description ---------|------------ -|`` |Specify a name for the cycles wallet. +| Argument | Description | +|----------|-------------| +| `` | Specify a name for the cycles wallet. | ### Example