diff --git a/doc/src/build/comms.md b/doc/src/build/comms.md index 079754b234b61..bcb5d46a62fe6 100644 --- a/doc/src/build/comms.md +++ b/doc/src/build/comms.md @@ -7,9 +7,10 @@ Now that you have [installed Sui](install.md), [connected to Devnet](../build/de The pages in this section provide various options for communicating with Sui: * Set up your [Sui RPC server and use the Sui JSON-RPC API](json-rpc.md) to interact with a local Sui network. -* Adhere to the [restrictions placed on JSON types](sui-json.md) to make them SuiJSON compatible. +* Optionally, use the [Sui CLI client](cli-client.md) to start and set up a local Sui network for contributing changes to the blockchain itself. * Interact with the Sui network via the [Sui Rust SDK](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](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](pubsub.md) on your Sui Fullnode using JSON-RPC notifications via the WebSocket API. -* Optionally, use the [Sui CLI client](cli-client.md) to start and set up a local Sui network for contributing changes to the blockchain itself. + +See the [Sui Reference Documentation](reference.md) for information on our API and SuiJSON format. diff --git a/doc/src/build/index.md b/doc/src/build/index.md index 3475c9f82d0c2..50aa9ca2cfda0 100644 --- a/doc/src/build/index.md +++ b/doc/src/build/index.md @@ -9,6 +9,7 @@ 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. [Create](../build/move/index.md) *smart contracts* with Move: 1. [Write](../build/move/write-package.md) a package. @@ -22,11 +23,11 @@ Here is our recommended workflow to interact with Sui: 1. [Enable](../build/programming-with-objects/ch5-child-objects.md) objects to own other objects. 1. [Talk](../build/comms.md) with Sui using our API and SDKs: * [Use](../build/json-rpc.md) the *Sui RPC Server and JSON-RPC API* to interact with a local Sui network. - * [Employ](../build/sui-json.md) *SuiJSON format* to align JSON inputs more closely with Move call arguments. - * [Follow](https://docs.sui.io/sui-jsonrpc) the Sui API Reference. * [Make](../build/rust-sdk.md) Rust SDK calls to Sui from your app. - * [Write](https://github.com/MystenLabs/sui/tree/main/sdk/typescript/) TypeScript/JavaScript apps. + * [Make](https://github.com/MystenLabs/sui/tree/main/sdk/typescript/) TypeScript/JavaScript calls to Sui from your apps. * [Run](../build/fullnode.md) a Sui Fullnode and [subscribe](../build/pubsub.md) to events. -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. [Reference](../build/reference.md) the format for our API and SuiJSON: + * [Follow](https://docs.sui.io/sui-jsonrpc) the Sui API Reference. + * [Employ](../build/sui-json.md) *SuiJSON format* to align JSON inputs more closely with Move call arguments. Find answers to common questions about our [roadmap](https://github.com/MystenLabs/sui/blob/main/ROADMAP.md) and more in our [FAQ](../contribute/faq.md). diff --git a/doc/src/build/reference.md b/doc/src/build/reference.md new file mode 100644 index 0000000000000..8acb0b93669e0 --- /dev/null +++ b/doc/src/build/reference.md @@ -0,0 +1,8 @@ +--- +title: Sui Reference Documentation +--- + +Use the references below to get the most out of Sui! + +* Review the [Sui API Reference](https://docs.sui.io/sui-jsonrpc) to understand our application programming interface. +* Adhere to the [restrictions placed on JSON types](sui-json.md) to make them SuiJSON compatible. \ No newline at end of file diff --git a/doc/src/navconfig.json b/doc/src/navconfig.json index 86d4df8c2a26b..b89cd7a60fb1b 100644 --- a/doc/src/navconfig.json +++ b/doc/src/navconfig.json @@ -200,6 +200,7 @@ }, { "label": "Reference", + "fileName": "build/reference", "title": "Reference", "items": [ {