Skip to content

Commit d15f47d

Browse files
0xmigosaharctsionescu
authored
[CLI][doc] refactor aptos cli doc site (aptos-labs#9072)
* refactor aptos cli doc site * Fix broken links * Require permission check before running run-indexer-tests --------- Co-authored-by: Christian Sahar <[email protected]> Co-authored-by: Stelian Ionescu <[email protected]>
1 parent a2c3c84 commit d15f47d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+229
-181
lines changed

RELEASE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The aptos node release tags are created for validator/fullnode deployment of the
3333
The aptos framework release tags are created to facilitate the on-chain framework upgrade of the given release branch. The minor number *Z* will increment when a new hot-fix release or a new framework update is required on this release branch.
3434

3535
### aptos-cli-v*X.Y.Z* release tag
36-
The aptos cli release tags are created to track the CLI versions for community to use when developing on the Aptos network. It's always recommended to upgrade your CLI when a new version is released, for the best user experience. Learn how to update to the [latest CLI version](https://aptos.dev/tools/install-cli/install-from-brew/#upgrading-the-cli).
36+
The aptos cli release tags are created to track the CLI versions for community to use when developing on the Aptos network. It's always recommended to upgrade your CLI when a new version is released, for the best user experience. Learn how to update to the [latest CLI version](https://aptos.dev/tools/aptos-cli/install-cli/install-from-brew/#upgrading-the-cli).
3737

3838
## Aptos Release Lifecycle
3939
(The time length here is a rough estimate, it varies depends on each release.)

aptos-move/framework/FRAMEWORK-PROVER-GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ This guide gives some hints to troubleshoot issues when using the prover for spe
22

33
## Installation
44

5-
Please refer to the [doc](https://aptos.dev/tools/install-cli/install-move-prover/).
5+
Please refer to the [doc](https://aptos.dev/tools/aptos-cli/install-cli/install-move-prover/).
66

77
## Timeout
88

aptos-move/move-examples/move-tutorial/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You should obtain a copy of the content of the directory in which this `README.m
3535
step_1 step_2 step_2_sol step_3 ...
3636
```
3737

38-
You also need a recent version of the [Aptos CLI](../../../developer-docs-site/docs/tools/install-cli/index.md). This tutorial is written using the following version:
38+
You also need a recent version of the [Aptos CLI](../../../developer-docs-site/docs/tools/aptos-cli/install-cli/index.md). This tutorial is written using the following version:
3939

4040
```shell
4141
> aptos --version
@@ -492,7 +492,7 @@ Read more about [phantom type](../../../developer-docs-site/docs/move/book/gener
492492
493493
## Step 7: Use the Move Prover
494494
495-
> NOTE: Before running the Move Prover, ensure that the [Move Prover](../../../developer-docs-site/docs/tools/install-cli/install-move-prover.md) and associated tools are installed.
495+
> NOTE: Before running the Move Prover, ensure that the [Move Prover](../../../developer-docs-site/docs/tools/aptos-cli/install-cli/install-move-prover.md) and associated tools are installed.
496496
497497
Smart contracts deployed on the blockchain may manipulate high-value assets. As a technique that uses strict
498498
mathematical methods to describe behavior and reason correctness of computer systems, formal verification

crates/aptos/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Aptos Command Line Interface (CLI) Tool
22

33
The `aptos` tool is a command line interface (CLI) for debugging, development, and node operation.
4-
See [Aptos CLI Documentation](https://aptos.dev/cli-tools/aptos-cli-tool/install-aptos-cli) for how to install the `aptos` CLI tool and how to use it.
4+
See [Aptos CLI Documentation](https://aptos.dev/cli-tools/aptos-cli/use-cli/install-aptos-cli) for how to install the `aptos` CLI tool and how to use it.

developer-docs-site/docs/guides/building-from-source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';
77

88
# Building Aptos From Source
99

10-
[Binary releases are available](../tools/install-cli/index.md), but if you want to build from source or develop on the Aptos tools, this is how.
10+
[Binary releases are available](../tools/aptos-cli/install-cli/index.md), but if you want to build from source or develop on the Aptos tools, this is how.
1111

1212
## Supported operating systems
1313

developer-docs-site/docs/guides/nfts/mint-nft-cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This tutorial assumes you have:
1212

1313
* a [GitHub account](https://docs.github.com/en/get-started/signing-up-for-github/signing-up-for-a-new-github-account)
1414
* the [GitHub CLI](https://cli.github.com/)
15-
* the [Aptos CLI](../../tools/install-cli/index.md) (or you can run from [aptos-core](https://github.com/aptos-labs/aptos-core) source via `cargo run`)
15+
* the [Aptos CLI](../../tools/aptos-cli/install-cli/index.md) (or you can run from [aptos-core](https://github.com/aptos-labs/aptos-core) source via `cargo run`)
1616
* the `aptos-core` repository checked out: `git clone https://github.com/aptos-labs/aptos-core.git`
1717

1818
Then:
@@ -44,7 +44,7 @@ In this section, we create a collection and token. This work maps to the demonst
4444

4545
### Create an account
4646

47-
1. [Install the Aptos CLI](../../tools/install-cli/index.md).
47+
1. [Install the Aptos CLI](../../tools/aptos-cli/install-cli/index.md).
4848

4949
2. Create a default (typical) account on Aptos devnet to receive the NFT by running the following command and selecting `devnet`:
5050
```shell

developer-docs-site/docs/guides/nfts/mint-onchain-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
99
You, as a developer, maybe also a game fancier, recently starts to develop a game and hope to
1010
integrate it with some web3 experience. You spontaneously think Aptos supports fungible tokens
1111
with abundant APIs in the token standard. So you wanna give a try to issue an in-game currency
12-
called *silver coin* by using the [Aptos command line interface (CLI)](../../tools/install-cli/index.md). There is only two requirements:
12+
called *silver coin* by using the [Aptos command line interface (CLI)](../../tools/aptos-cli/install-cli/index.md). There is only two requirements:
1313
- The token is fungible
1414
- The token is associated with a URL that points to the coin image.
1515

developer-docs-site/docs/guides/nfts/nft-minting-tool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The Aptos Non-Fungible Token (NFT) Minting Tool allows NFT creators to upload as
1919

2020
### Install Aptos CLI
2121

22-
[Install the Aptos CLI](../../tools/install-cli/index.md). The Aptos CLI is needed for compiling and deploying the minting contract.
22+
[Install the Aptos CLI](../../tools/aptos-cli/install-cli/index.md). The Aptos CLI is needed for compiling and deploying the minting contract.
2323

2424
### Configure Aptos account
2525

developer-docs-site/docs/guides/running-a-local-multi-node-network.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ cargo run -p aptos-faucet-cli -- --amount 10 --accounts <account_address> --key
8080
:::tip Faucet and Aptos CLI
8181
See more on how the faucet works in the [README](https://github.com/aptos-labs/aptos-core/tree/main/crates/aptos-faucet).
8282

83-
Also see how to use the [Aptos CLI](../tools/aptos-cli-tool/use-aptos-cli.md#account-examples) with an existing faucet.
83+
Also see how to use the [Aptos CLI](../tools/aptos-cli/use-cli/use-aptos-cli.md#account-examples) with an existing faucet.
8484
:::
8585

8686
## Validator fullnodes

developer-docs-site/docs/guides/system-integrators-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ See [Aptos Blockchain Deployments](../nodes/deployments.md) for full details on
4141

4242
There are two options for running a local testnet:
4343
* Directly [run a local testnet](../nodes/local-testnet/run-a-local-testnet.md) using either the [Aptos-core source code](../nodes/local-testnet/run-a-local-testnet.md#using-the-aptos-core-source-code) or a [Docker image](../nodes/local-testnet/run-a-local-testnet.md#using-docker). These paths are useful for testing changes to the Aptos-core codebase or framework, or for building services on top of the Aptos blockchain, respectively.
44-
* [Install the Aptos CLI](../tools/install-cli/index.md) and 2) start a [local node with a faucet](../nodes/local-testnet/using-cli-to-run-a-local-testnet.md#starting-a-local-testnet-with-a-faucet). This path is useful for developing on the Aptos blockchain, debugging Move contracts, and testing node operations.
44+
* [Install the Aptos CLI](../tools/aptos-cli/install-cli/index.md) and 2) start a [local node with a faucet](../nodes/local-testnet/using-cli-to-run-a-local-testnet.md#starting-a-local-testnet-with-a-faucet). This path is useful for developing on the Aptos blockchain, debugging Move contracts, and testing node operations.
4545

4646
Either of these methods will expose a [REST API service](../integration/aptos-apis.md) at `http://127.0.0.1:8080` and a Faucet API service at `http://127.0.0.1:8000` for option 1 run a local testnet or `http://127.0.0.1:8081` for option 2 install the Aptos CLI. The applications will output the location of the services.
4747

@@ -84,7 +84,7 @@ Aptos currently provides three SDKs:
8484
2. [Python](../sdks/python-sdk.md)
8585
3. [Rust](../sdks/rust-sdk.md)
8686

87-
Almost all developers will benefit from exploring the CLI. [Using the CLI](../tools/aptos-cli-tool/use-aptos-cli.md) demonstrates how the CLI can be used to which includes creating accounts, transferring coins, and publishing modules.
87+
Almost all developers will benefit from exploring the CLI. [Using the CLI](../tools/aptos-cli/use-cli/use-aptos-cli.md) demonstrates how the CLI can be used to which includes creating accounts, transferring coins, and publishing modules.
8888

8989
## Accounts on Aptos
9090

@@ -98,7 +98,7 @@ At creation, an [Aptos account](https://github.com/aptos-labs/aptos-core/blob/88
9898
* An [event handle](../concepts/events.md) for all new types of coins added to the account.
9999
* An event handle for all key rotations for the account.
100100

101-
Read more about [Accounts](../concepts/accounts.md) and [set one up](../tools/aptos-cli-tool/use-aptos-cli#initialize-local-configuration-and-create-an-account).
101+
Read more about [Accounts](../concepts/accounts.md) and [set one up](../tools/aptos-cli/use-cli/use-aptos-cli#initialize-local-configuration-and-create-an-account).
102102

103103
## Transactions
104104

@@ -502,7 +502,7 @@ To learn more about coin creation, make ["Your First Coin"](../tutorials/first-c
502502

503503
## Integrating with the faucet
504504

505-
This tutorial is for SDK and wallet developers who want to integrate with the [Aptos Faucet](https://github.com/aptos-labs/aptos-core/tree/main/crates/aptos-faucet). If you are a dapp developer, you should access the faucet through an existing [SDK](../tutorials/first-transaction.md) or [CLI](../tools/aptos-cli-tool/use-aptos-cli#initialize-local-configuration-and-create-an-account) instead.
505+
This tutorial is for SDK and wallet developers who want to integrate with the [Aptos Faucet](https://github.com/aptos-labs/aptos-core/tree/main/crates/aptos-faucet). If you are a dapp developer, you should access the faucet through an existing [SDK](../tutorials/first-transaction.md) or [CLI](../tools/aptos-cli/use-cli/use-aptos-cli#initialize-local-configuration-and-create-an-account) instead.
506506

507507
### Differences between devnet and testnet
508508
What are the differences between devnet and testnet? Effectively none. In the past, the testnet faucet had a Captcha in front of it, making it unqueryable by normal means. This is no longer true.

0 commit comments

Comments
 (0)