Skip to content

Commit

Permalink
Restore links to CLI Client file moved back to build directory (Myste…
Browse files Browse the repository at this point in the history
…nLabs#4360)

* Restore links to CLI Client file moved back to build directory

* Update index.md
  • Loading branch information
Clay-Mysten authored Aug 30, 2022
1 parent 943e923 commit 48bb935
Show file tree
Hide file tree
Showing 14 changed files with 25 additions and 24 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

* To learn how to use Sui, take our [end-to-end tutorial](doc/src/explore/tutorials.md).
* To jump right into building smart contract applications on top of Sui, start at the [Move Smart Contract Quick Start](doc/src/build/move/index.md).
* To experiment with the Sui CLI client, check out [Sui CLI client Quick Start](doc/src/contribute/cli-client.md).
* To experiment with the Sui CLI client, check out [Sui CLI client Quick Start](doc/src/build/cli-client.md).
* To understand what's possible by browsing Move code built on top of Sui, review the [examples](doc/src/explore/examples.md).
* To start coding against Sui's JSON-RPC APIs, start at [JSON-RPC API Quick Start](doc/src/build/json-rpc.md).
* To learn what distinguishes Sui from other blockchain systems, see [How Sui Differs?](doc/src/learn/sui-compared.md).
Expand Down
2 changes: 1 addition & 1 deletion crates/sui-framework/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is a proof-of-concept Move standard library for Sui (`sources/`), along with several examples of programs that Sui users might want to write (`examples`). `custom_object_template.move` is a good starting point for understanding the proposed model.

To set up and build the [Sui CLI client](https://docs.sui.io/contribute/cli-client) needed for Move development, follow the instructions to [install Sui](https://docs.sui.io/build/install).
To set up and build the [Sui CLI client](https://docs.sui.io/build/cli-client) needed for Move development, follow the instructions to [install Sui](https://docs.sui.io/build/install).

## To add a new native Move function

Expand Down
2 changes: 1 addition & 1 deletion crates/sui-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This directory contains examples of interacting with a Move language smart contr
#### 1. Prepare the environment
1. Install `sui` and `rpc-server` binaries following the [Sui installation](https://github.com/MystenLabs/sui/blob/main/doc/src/build/install.md#binaries) docs.
1. [Connect to Sui Devnet](https://github.com/MystenLabs/sui/blob/main/doc/src/build/devnet.md).
1. [Make sure you have two addresses with gas](https://github.com/MystenLabs/sui/blob/main/doc/src/contribute/cli-client.md#adding-accounts-to-the-client) by using the `new-address` command to create new addresses:
1. [Make sure you have two addresses with gas](https://github.com/MystenLabs/sui/blob/main/doc/src/build/cli-client.md#adding-accounts-to-the-client) by using the `new-address` command to create new addresses:
```shell
sui client new-address
```
Expand Down
6 changes: 3 additions & 3 deletions doc/src/build/devnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Connect to Sui Devnet

Welcome to the Sui Devnet. We are hosting a public Devnet for the community to experiment with our tech and help to shape the future of the Sui network. It exists to gain operational experience with the Sui software in a public setting prior to our Mainnet launch.

To instead [contribute](../contribute/index.md) to Sui itself, you may experiment with the advanced [Sui CLI client](../contribute/cli-client.md) at the command line.
To instead [contribute](../contribute/index.md) to Sui itself, you may experiment with the advanced [Sui CLI client](../build/cli-client.md) at the command line.


The Sui Devnet currently consists of:
Expand All @@ -19,7 +19,7 @@ Many improvements to the Sui Devnet are underway, such as the ability to run ful

We provide the following tools for users to interact with the Sui Devnet:

* The [Sui Wallet command line interface (CLI)](../contribute/cli-client.md)
* The [Sui Wallet command line interface (CLI)](../build/cli-client.md)
* create and manage your private keys
* submit transactions for creating example NFTs
* call and publish Move modules
Expand Down Expand Up @@ -102,7 +102,7 @@ Owner: Account Address ( 9E9A9D406961E478AA80F4A6B2B167673F3DF8BA )
Type: 0x2::devnet_nft::DevNetNFT
```
The above command created an object with ID `ED883F6812AF447B9B0CE220DA5EA9E0F58012FE`. Note you may use `Sui CLI client` to [view objects owned by the address](../contribute/cli-client.md#view-objects-owned-by-the-address).
The above command created an object with ID `ED883F6812AF447B9B0CE220DA5EA9E0F58012FE`. Note you may use `Sui CLI client` to [view objects owned by the address](../build/cli-client.md#view-objects-owned-by-the-address).
Now you can view the created object in the [Sui Explorer](https://explorer.devnet.sui.io) by appending the object ID to:
https://explorer.devnet.sui.io/objects/
Expand Down
5 changes: 3 additions & 2 deletions doc/src/build/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ Now that you've [learned about Sui](../learn/index.md), it's time to start build
Here is our recommended workflow to interact with Sui:

1. [Install](../build/install.md) all of the *required tools*.
1. Optionally, [create](../contribute/cli-client.md#genesis) and [start](../contribute/cli-client.md#starting-the-network) a *local Sui network* to contribute to the blockchain.
1. [Connect](../build/devnet.md) to the Sui Devnet network.
1. Interact with the Sui network:
* Simply [connect](../build/devnet.md) to the Sui Devnet network to begin working with Sui immediately.
* Optionally, [create](../build/cli-client.md#genesis) and [start](../build/cli-client.md#starting-the-network) a *local Sui network* to contribute to the blockchain.
1. [Create](../build/move/index.md) *smart contracts* with Move:
1. [Write](../build/move/write-package.md) a package.
1. [Build and test](../build/move/build-test.md) a package.
Expand Down
4 changes: 2 additions & 2 deletions doc/src/contribute/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ For developers:

1. [Install Sui](https://docs.sui.io/build/install).
2. Spin up a [Sui Fullnode](../build/fullnode.md).
3. Experiment with the [Sui CLI client](../contribute/cli-client.md).
3. Experiment with the [Sui CLI client](../build/cli-client.md).
4. Join the [Move](https://discord.gg/8prNjUqyFj) and [Sui](https://discord.gg/CVcnUzKYCB) developer channels in Discord.
5. [Start building](https://docs.sui.io/build)!

Expand Down Expand Up @@ -140,7 +140,7 @@ We accepted applications for validators to participate in Wave 1 of the Incentiv

We have a public [Sui Devnet](../build/devnet.md) with nodes operated by Mysten Labs. And you can now run a networked [Sui Fullnode](../build/fullnode.md).

You may also run a local, non-networked Sui node for development using the [Sui CLI client](../contribute/cli-client.md). You can interact with the nodes with either the [Sui Wallet CLI](../contribute/cli-client.md#command-line-mode) or over the [Sui RPC API](../build/json-rpc.md).
You may also run a local, non-networked Sui node for development using the [Sui CLI client](../build/cli-client.md). You can interact with the nodes with either the [Sui Wallet CLI](../build/cli-client.md#command-line-mode) or over the [Sui RPC API](../build/json-rpc.md).

We have a Testnet that will soon allow others to operate Sui nodes; see our [roadmap](https://github.com/MystenLabs/sui/blob/main/ROADMAP.md#roadmap).

Expand Down
6 changes: 3 additions & 3 deletions doc/src/explore/tutorials.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ title: End-to-End Tutorial to Set Up and Play TicTacToe on Sui
---

In this tutorial, we demonstrate the end-to-end process for starting a
Sui network locally, connecting to it through our [CLI client](../contribute/cli-client.md)
Sui network locally, connecting to it through our [CLI client](../build/cli-client.md)
app, publishing a TicTacToe game written in [Move](../build/move/index.md) on Sui,
and playing it to the end.

## Set up

1. [Install Sui binaries](../build/install.md#binaries) and
[download Sui source code](../build/install.md#source-code).
1. [Create Sui genesis](../contribute/cli-client.md#genesis) by running the
1. [Create Sui genesis](../build/cli-client.md#genesis) by running the
`sui genesis` command.
1. [Start the Sui network](../contribute/cli-client.md#starting-the-network) by
1. [Start the Sui network](../build/cli-client.md#starting-the-network) by
running the `sui start` command.

After completing these steps, you will have a running local Sui instance and
Expand Down
2 changes: 1 addition & 1 deletion doc/src/explore/wallet-browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Welcome to the [Sui Wallet Browser Chrome Extension](https://chrome.google.com/w

Initially, the Sui Wallet Browser Extension is aimed at Sui developers for testing purposes. As such, the tokens are of no value (just like the rest of [DevNet](../build/devnet.md)) and will disappear each time we reset the network. In time, the Sui Wallet Browser Extension will be production ready for real tokens.

This browser extension is a pared-down version of the [Sui CLI client](../contribute/cli-client.md) that provides greater ease of use for the most commonly used features. If you need more advanced features, such as merging/splitting coins and making arbitrary [Move](../build/move/index.md) calls, instead use the [Sui CLI client](../contribute/cli-client.md).
This browser extension is a pared-down version of the [Sui CLI client](../build/cli-client.md) that provides greater ease of use for the most commonly used features. If you need more advanced features, such as merging/splitting coins and making arbitrary [Move](../build/move/index.md) calls, instead use the [Sui CLI client](../build/cli-client.md).

## Features

Expand Down
2 changes: 1 addition & 1 deletion doc/src/learn/architecture/validators.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Sui uses proof of stake (PoS) to determine which validators operate the network

## Epochs

Operation of the Sui network is temporally partitioned into non-overlapping, approximate fixed-duration (e.g. 24-hour) *epochs*. During a particular epoch, the set of validators participating in the network is fixed. At an epoch boundary, reconfiguration may occur and can change the set of validators participating in the network and their voting power. Conceptually, reconfiguration starts a new instance of the Sui protocol with the previous epoch's final state as [genesis](../../contribute/cli-client.md#genesis) and the new set of validators as the operators.
Operation of the Sui network is temporally partitioned into non-overlapping, approximate fixed-duration (e.g. 24-hour) *epochs*. During a particular epoch, the set of validators participating in the network is fixed. At an epoch boundary, reconfiguration may occur and can change the set of validators participating in the network and their voting power. Conceptually, reconfiguration starts a new instance of the Sui protocol with the previous epoch's final state as [genesis](../../build/cli-client.md#genesis) and the new set of validators as the operators.

## Quorums

Expand Down
4 changes: 2 additions & 2 deletions doc/src/learn/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The links in the section point to information to help you start working with Sui
Go to the [Move Quick Start](../build/move/index.md) for information about installation, defining custom objects, object operations (create/destroy/update/transfer/freeze), publishing, and invoking your published code.

### Start the Sui network with Sui CLI client
See the [Sui CLI client Quick Start](../contribute/cli-client.md) for information about installation, querying the chain, client setup, sending transfer transactions, and viewing the effects.
See the [Sui CLI client Quick Start](../build/cli-client.md) for information about installation, querying the chain, client setup, sending transfer transactions, and viewing the effects.

### Take the end-to-end tutorial
Proceed to the [Sui Tutorial](../explore/tutorials.md) for a summary view of setting up your environment, starting a Sui network, gathering accounts and gas, and publishing and playing a game in Sui.
Expand All @@ -64,7 +64,7 @@ Navigate and search this site however you see fit. If you're new to Sui, we reco
**Build** - includes information about how to:
* [Install Sui](../build/install.md)
* [Create smart contracts with Move](../build/move/index.md)
* [Set up and configure a local Sui network](../contribute/cli-client.md)
* [Set up and configure a local Sui network](../build/cli-client.md)
* [Start a local JSON-RPC Gateway server](../build/json-rpc.md#start-local-rpc-server)

**Explore** - includes more in-depth information about:
Expand Down
2 changes: 1 addition & 1 deletion doc/src/learn/sui-compared.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Contrary to many traditional blockchains, Sui does not make strong synchrony ass

### Efficient local read operations

The reading process of Sui enormously differs from other blockchains. Users interested in only a handful of objects and their history perform authenticated reads at a low granularity and low latency. Sui creates a narrow family tree of objects starting from the [genesis](https://github.com/MystenLabs/sui/blob/main/doc/src/contribute/cli-client.md#genesis) allowing it to read only objects tied to the sender of the transaction. Users requiring a global view of the system (e.g., to audit the system) can take advantage of checkpoints to improve performance.
The reading process of Sui enormously differs from other blockchains. Users interested in only a handful of objects and their history perform authenticated reads at a low granularity and low latency. Sui creates a narrow family tree of objects starting from the [genesis](https://github.com/MystenLabs/sui/blob/main/doc/src/build/cli-client.md#genesis) allowing it to read only objects tied to the sender of the transaction. Users requiring a global view of the system (e.g., to audit the system) can take advantage of checkpoints to improve performance.

In traditional blockchains, families are ordered with respect to each other to totally order transactions. This then requires querying a massive blob for the precise information needed. Disk I/O thus becomes a performance bottleneck, and some blockchains [now require SSD drives](https://www.usenix.org/system/files/conference/hotstorage18/hotstorage18-paper-raju.pdf) on their validators as a result.

Expand Down
6 changes: 3 additions & 3 deletions doc/src/learn/sui-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Sui provides a gateway service that enables third parties, such as app or game d

Genesis is the initial act of creating accounts and gas objects. Sui provides a `genesis` command that allows users to create and inspect the genesis object setting up the network for operation.

For more information, see [Genesis](../contribute/cli-client.md#genesis).
For more information, see [Genesis](../build/cli-client.md#genesis).

### Multi-writer objects

Expand Down Expand Up @@ -107,10 +107,10 @@ More *complex transactions* affecting objects that are shared or owned by multip
### Transfer

A transfer is switching the owner address of a token to a new one via command in Sui. This is accomplished via the
[Sui CLI client](../contribute/cli-client.md) command line interface. It is one of the more common of many commands
[Sui CLI client](../build/cli-client.md) command line interface. It is one of the more common of many commands
available in the CLI client.

For more information, see [Transferring objects](../contribute/cli-client.md#transferring-objects).
For more information, see [Transferring objects](../build/cli-client.md#transferring-objects).

### Validator

Expand Down
2 changes: 1 addition & 1 deletion doc/src/navconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
},
{
"label": "Optional - Run Locally with CLI",
"fileName": "contribute/cli-client"
"fileName": "build/cli-client"
},
{
"label": "Create Smart Contracts with Move",
Expand Down
4 changes: 2 additions & 2 deletions doc/src/siteconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,8 @@
"url": "/build/move"
},
{
"name": "Start Sui Network",
"url": "/contribute/cli-client"
"name": "Connect to Devnet",
"url": "/build/devnet"
},
{
"name": "Program Sui Objects",
Expand Down

0 comments on commit 48bb935

Please sign in to comment.