Skip to content

Commit

Permalink
Update path to Devnet and CLI Client pages to reflect new locations i…
Browse files Browse the repository at this point in the history
…n nav (MystenLabs#4048)

* Update patch to Devnet and CLI Client pages to reflect new locations in nav

* Update README.md

* Update cli-client.md

* Update README.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update json-rpc.md

* Update devnet.md

* Update navconfig.json
  • Loading branch information
Clay-Mysten authored Aug 17, 2022
1 parent 1a6493b commit 44ccb03
Show file tree
Hide file tree
Showing 16 changed files with 28 additions and 28 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/build/cli-client.md).
* To experiment with the Sui CLI client, check out [Sui CLI client Quick Start](doc/src/contribute/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/build/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/contribute/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 doc/book/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ All code samples in this book are written with the assumption that you use *Sui
$ cargo install --locked --git https://github.com/MystenLabs/sui.git --branch "main" sui
```

Keep in mind that the branch is set to `main`. If you're developing with our [devnet](https://docs.sui.io/explore/devnet), instead follow the instructions to [install Sui](https://docs.sui.io/build/install#binaries).
Keep in mind that the branch is set to `main`. If you're developing with our [devnet](https://docs.sui.io/build/devnet), instead follow the instructions to [install Sui](https://docs.sui.io/build/install#binaries).
2 changes: 1 addition & 1 deletion doc/src/build/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ See more [IDE options](https://github.com/MystenLabs/awesome-move#ides) in the [
## SUI tokens
To [experiment with Devnet](../explore/devnet.md) or [use the Sui Wallet Browser Extension](../explore/wallet-browser.md), you will need SUI tokens. These coins have no financial value and will disappear each time we reset the network.
To [experiment with Devnet](../build/devnet.md) or [use the Sui Wallet Browser Extension](../explore/wallet-browser.md), you will need SUI tokens. These coins have no financial value and will disappear each time we reset the network.
To request SUI test tokens:
Expand Down
2 changes: 1 addition & 1 deletion doc/src/build/rust-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Interact with Sui over Rust SDK
---

## Overview
The [Sui SDK](https://github.com/MystenLabs/sui/tree/main/crates/sui-sdk) is a collection of Rust language JSON-RPC wrapper and crypto utilities you can use to interact with the [Sui Devnet Gateway](../explore/devnet.md) and [Sui Full Node](fullnode.md).
The [Sui SDK](https://github.com/MystenLabs/sui/tree/main/crates/sui-sdk) is a collection of Rust language JSON-RPC wrapper and crypto utilities you can use to interact with the [Sui Devnet Gateway](../build/devnet.md) and [Sui Full Node](fullnode.md).

The [`SuiClient`](cli-client.md) can be used to create an HTTP (`SuiClient::new_http_client`) or a WebSocket client(`SuiClient::new_ws_client`).
See our [JSON-RPC](json-rpc.md#sui-json-rpc-methods) doc for the list of available methods.
Expand Down
8 changes: 4 additions & 4 deletions doc/src/contribute/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Yes, the token name will be SUI.

### When is the Sui Devnet/Testnet/Mainnet launching?

We have launched our [Sui Devnet](../explore/devnet.md) in May 2022. A Testnet is coming in a few months.
We have launched our [Sui Devnet](../build/devnet.md) in May 2022. A Testnet is coming in a few months.

See our roadmap: \
[https://github.com/MystenLabs/sui/blob/main/ROADMAP.md#roadmap](https://github.com/MystenLabs/sui/blob/main/ROADMAP.md#roadmap)
Expand All @@ -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](../build/cli-client.md).
3. Experiment with the [Sui CLI client](../contribute/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 @@ -138,9 +138,9 @@ See the instructions to [run a Sui Fullnode](../build/fullnode.md).

You can now [register to participate](https://airtable.com/shr3phh3FCZYhZUDF) in [Sui Incentivized Testnet as a validator](https://sui.io/resources-sui/validator-registration-open/)!

We have a public [Sui Devnet](../explore/devnet.md) with nodes operated by Mysten Labs. And you can now run a networked [Sui Fullnode](../build/fullnode.md).
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](../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).
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).

Soon we will have a Testnet that allow others to operate Sui nodes, but both are on our [roadmap](https://github.com/MystenLabs/sui/blob/main/ROADMAP.md#roadmap). Right now,

Expand Down
2 changes: 1 addition & 1 deletion doc/src/explore/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Find answers to common questions about our [roadmap](https://github.com/MystenLa

Experiment with:

* [Sui DevNet](../explore/devnet.md) - to gain operational experience with the Sui software in a public setting
* [Sui DevNet](../build/devnet.md) - to gain operational experience with the Sui software in a public setting
* [Sui Incentivized Testnet](https://sui.io/resources-sui/announcing-sui-incentivized-testnet/) - will feature a menu of incentives to encourage and reward meaningful participation during the Testnet waves

## Tutorial
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](../build/cli-client.md)
Sui network locally, connecting to it through our [CLI client](../contribute/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](../build/cli-client.md#genesis) by running the
1. [Create Sui genesis](../contribute/cli-client.md#genesis) by running the
`sui genesis` command.
1. [Start the Sui network](../build/cli-client.md#starting-the-network) by
1. [Start the Sui network](../contribute/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
4 changes: 2 additions & 2 deletions doc/src/explore/wallet-browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Welcome to the [Sui Wallet Browser Chrome Extension](https://chrome.google.com/w

## Purpose

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](../explore/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.
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](../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).
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).

## 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 @@ -10,7 +10,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](../../build/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](../../contribute/cli-client.md#genesis) and the new set of validators as the operators.

## Quorums

Expand Down
6 changes: 3 additions & 3 deletions doc/src/learn/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,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](../build/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](../contribute/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 @@ -56,12 +56,12 @@ 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](../build/cli-client.md)
* [Set up and configure a local Sui network](../contribute/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:
* [Sui Wallet](../explore/wallet-browser.md)
* [Devnet](../explore/devnet.md)
* [Devnet](../build/devnet.md)
* [Sui tutorials](../explore/tutorials.md)
* [Sui prototypes](../explore/prototypes.md)
* [Sui examples](../explore/examples.md)
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/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.
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.

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](../build/cli-client.md#genesis).
For more information, see [Genesis](../contribute/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](../build/cli-client.md) command line interface. It is one of the more common of many commands
[Sui CLI client](../contribute/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](../build/cli-client.md#transferring-objects).
For more information, see [Transferring objects](../contribute/cli-client.md#transferring-objects).

### Validator

Expand Down
6 changes: 3 additions & 3 deletions doc/src/navconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"items": [
{
"label": "Devnet",
"link": "explore/devnet"
"link": "build/devnet"
},
{
"label": "examples.sui.io",
Expand Down Expand Up @@ -114,7 +114,7 @@
},
{
"label": "Connect to Sui Devnet",
"fileName": "explore/devnet"
"fileName": "build/devnet"
},
{
"label": "Create Smart Contracts with Move",
Expand Down Expand Up @@ -237,7 +237,7 @@
},
{
"label": "Sui CLI and Local Network",
"fileName": "build/cli-client"
"fileName": "contribute/cli-client"
},
{
"label": "Logging",
Expand Down
2 changes: 1 addition & 1 deletion doc/src/siteconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
},
{
"name": "Start Sui Network",
"url": "/build/cli-client"
"url": "/contribute/cli-client"
},
{
"name": "Program Sui Objects",
Expand Down
2 changes: 1 addition & 1 deletion explorer/client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,4 @@ Currently the Explorer supports
- Address page with owned objects
- Search for transactions, addresses, and Objects by ID

See [Experiment with Sui DevNet](https://docs.sui.io/explore/devnet) for use.
See [Experiment with Sui DevNet](https://docs.sui.io/build/devnet) for use.

0 comments on commit 44ccb03

Please sign in to comment.