From dd37ce1694f1dc242b6f5710935d35ce0bde0917 Mon Sep 17 00:00:00 2001 From: Clay-Mysten <100217682+Clay-Mysten@users.noreply.github.com> Date: Thu, 4 Aug 2022 10:36:04 -0700 Subject: [PATCH] Reorganize Build nav with Talk subsection for Rust SDK and related docs (#3746) * Reorganize Build nav with Talk subsection for Rust SDK and related docs * Add See Sui JSON-RPC API reference to new Talk subsection --- doc/src/build/cli-client.md | 2 +- doc/src/build/comms/index.md | 13 ++++++++ doc/src/build/fullnode.md | 3 +- doc/src/build/pubsub.md | 2 +- doc/src/navconfig.json | 57 ++++++++++++++++++++++++------------ 5 files changed, 56 insertions(+), 21 deletions(-) create mode 100644 doc/src/build/comms/index.md diff --git a/doc/src/build/cli-client.md b/doc/src/build/cli-client.md index aad5d06471333..818caf5514572 100644 --- a/doc/src/build/cli-client.md +++ b/doc/src/build/cli-client.md @@ -1,5 +1,5 @@ --- -title: Sui CLI Quick Start +title: Use Sui CLI to Start and Manage Network --- Welcome to the Sui tutorial on the Sui CLI developed diff --git a/doc/src/build/comms/index.md b/doc/src/build/comms/index.md new file mode 100644 index 0000000000000..cd2bbff81b662 --- /dev/null +++ b/doc/src/build/comms/index.md @@ -0,0 +1,13 @@ +--- +title: Connect and Communicate with the Sui Network +--- + +Now that you have [installed Sui](../../build/install.md), [started the Sui network](../../build/cli-client.md), and learned how to [create smark contracts in Move](../../build/move/index.md) and [program Sui objects](../../build/programming-with-objects/index.md), it's time to let your apps talk to Sui. The pages in this section provide various options for communicating with Sui. + +* Use the [Sui CLI client](../../build/cli-client.md) to start and set up the Sui network. +* Set up your own [local Sui RPC server and use the Sui JSON-RPC API](../../build/json-rpc.md) to interact with a local Sui network. +* Adhere to the [restrictions placed on JSON types](../../build/sui-json.md) to make them SuiJSON compatible. +* Interact with the Sui network via the [Sui Rust SDK](../../build/rust-sdk.md), a collection of Rust language JSON-RPC wrapper and crypto utilities. +* Sign transactions and interact with the Sui network using the [Sui TypeScript SDK](https://github.com/MystenLabs/sui/tree/main/sdk/typescript) built on the Sui JSON RPC API. +* Run a [Sui Fullnode](../../build/fullnode.md) yourself to store the full Sui blockchain state and history and qualify as a [potential validator](https://sui.io/resources-sui/validator-registration-open/). +* Filter and subscribe to a [real-time event stream](../../build/pubsub.md) on your Sui Fullnode using JSON-RPC notifications via the WebSocket API. \ No newline at end of file diff --git a/doc/src/build/fullnode.md b/doc/src/build/fullnode.md index acf4ab3006920..e1b4a993f6765 100644 --- a/doc/src/build/fullnode.md +++ b/doc/src/build/fullnode.md @@ -15,7 +15,8 @@ transactions (or a block of transactions), the validator will push that block to a fullnode (potentially a number of fullnodes) who will then in turn disseminate it to the rest of the network. -**Important**: For potential validators, running a Sui fullnode is an absolute +**Important**: For [potential validators](https://sui.io/resources-sui/validator-registration-open/), +running a Sui fullnode is an absolute prerequisite. We encourage auditors, bridges, state mirrors and other interested parties to join us. At this time, we offer no guarantees on performance or stability of our fullnode software. We expect things to evolve and stabilize diff --git a/doc/src/build/pubsub.md b/doc/src/build/pubsub.md index 25dae6e39fc67..7fc629db0cd7d 100644 --- a/doc/src/build/pubsub.md +++ b/doc/src/build/pubsub.md @@ -2,7 +2,7 @@ title: Subscribe to JSON-RPC Real-Time Events --- -Sui [fullnode](fullnode.md) supports publish / subscribe using [JSON-RPC](json-rpc.md) notifications via websocket. +Sui [fullnode](fullnode.md) supports publish / subscribe using [JSON-RPC](json-rpc.md) notifications via the WebSocket API. This service allows clients to filter and subscribe to a real-time event stream generated from Move or from the Sui network. diff --git a/doc/src/navconfig.json b/doc/src/navconfig.json index b64f60b8d3fba..14d942e5cad86 100644 --- a/doc/src/navconfig.json +++ b/doc/src/navconfig.json @@ -112,6 +112,10 @@ "label": "Install Sui", "fileName": "build/install" }, + { + "label": "Use Sui CLI to Start Network", + "fileName": "build/cli-client" + }, { "label": "Create Smart Contracts with Move", "fileName": "build/move/index", @@ -135,10 +139,6 @@ } ] }, - { - "label": "Use Sui CLI", - "fileName": "build/cli-client" - }, { "label": "Program with Objects", "fileName": "build/programming-with-objects/index", @@ -167,20 +167,41 @@ ] }, { - "label": "Use Sui RPC Server", - "fileName": "build/json-rpc" - }, - { - "label": "Employ SuiJSON Format", - "fileName": "build/sui-json" - }, - { - "label": "Run a Fullnode", - "fileName": "build/fullnode" - }, - { - "label": "Subscribe to Events", - "fileName": "build/pubsub" + "label": "Talk with Sui", + "fileName": "build/comms/index", + "title": "Talk with Sui", + "items": [ + { + "label": "Use Sui RPC Server", + "fileName": "build/json-rpc" + }, + { + "label": "Employ SuiJSON Format", + "fileName": "build/sui-json" + }, + { + "label": "See Sui JSON-RPC API reference", + "link": "https://docs.sui.io/sui-jsonrpc", + "external": true + }, + { + "label": "Make calls with Rust SDK", + "fileName": "build/rust-sdk" + }, + { + "label": "Write TypeScript/JavaScript", + "link": "https://github.com/MystenLabs/sui/tree/main/sdk/typescript", + "external": true + }, + { + "label": "Run a Fullnode", + "fileName": "build/fullnode" + }, + { + "label": "Subscribe to Events", + "fileName": "build/pubsub" + } + ] } ], "explore": [