diff --git a/CODE_OF_CONDUCT.MD b/CODE_OF_CONDUCT.MD index 22a9a38c6b7f1..d2f1b67a3fa2c 100644 --- a/CODE_OF_CONDUCT.MD +++ b/CODE_OF_CONDUCT.MD @@ -19,7 +19,7 @@ diverse, inclusive, and healthy community. ## More information -See the central [Sui Code of Conduct](doc/src/contribute/code-of-conduct.md) for +See the central [Sui Code of Conduct](https://github.com/MystenLabs/sui/blob/main/docs/content/references/contribute/code-of-conduct.mdx) for full details. Our Code of Conduct is adapted from the diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ba6e415f9e855..209e027ef10e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,17 @@ # Contributors -## How to Contribute +Thanks for considering making a contribution to the Sui network or its documentation. The Sui monorepo houses the code that powers and documents the Sui blockchain. -See [Contributing to Sui](doc/src/contribute/index.md) for instructions on helping Sui grow. +## Contribute to Sui -See [ISSUES.md](./ISSUES.md) for filing bug reports. +See [Sui Environment Setup](https://github.com/MystenLabs/sui/blob/main/docs/content/guides/developer/getting-started/sui-environment.mdx) for approach to submitting code fixes and enhancements. -See [CONTRIBUTING.md](./crates/sui-framework/CONTRIBUTING.md) for information related to `sui-framework` crate contributions.. +If you want to contribute code that creates a feature on Sui, start with a [Sui Improvement Proposal](https://github.com/sui-foundation/sips/tree/main) before developing the logic. + +Found a bug or security vulnerability? Create a [GitHub issue](https://github.com/MystenLabs/sui/issues/new/choose). + +Found a small error or typo in the documentation? Each page on the [sui.docs.io](https://sui.docs.io) site includes an **Edit this page** link at the bottom that you can use to edit the page in GitHub. The content is located in the docs/content directory of the Sui repo, so you can make a usual PR if you prefer. + +For larger documentation issues, you can [create an issue](https://github.com/MystenLabs/sui/issues/new/choose) in GitHub. To fix the problem yourself, follow the [documentation contribution](./docs/content/references/contribute/contribution-process.mdx) guidelines. + +Want to contribute to the Sui framework? See [CONTRIBUTING.md](https://github.com/MystenLabs/sui/blob/main/crates/sui-framework/CONTRIBUTING.md) for information related to `sui-framework` crate contributions. diff --git a/ISSUES.md b/ISSUES.md deleted file mode 100644 index 2280eeabb2424..0000000000000 --- a/ISSUES.md +++ /dev/null @@ -1,32 +0,0 @@ -# Template for Reporting Issues - -Use the following template to report issues in the Sui GitHub repo: - -``` -## Steps to Reproduce Issue - -Fill this in with the concrete steps needed to reproduce the bug. When providing code in the reproduction steps, use the smallest snippet of code that demonstrates the issue, removing any extraneous details. - -e.g. -1. Call function . -2. Use return value and call . - -## Expected Result - -Specify what outcome you expected should have resulted, but didn't. - -e.g. -Expected to return 42. - -## Actual Result - -Specify what the actual unexpected outcome was. - -e.g. - returned 41. - -## System Information - -* OS: -* Compiler: -``` diff --git a/crates/sui-sdk/README.md b/crates/sui-sdk/README.md index 96e095662aaec..78c71729e7ebe 100644 --- a/crates/sui-sdk/README.md +++ b/crates/sui-sdk/README.md @@ -160,18 +160,18 @@ See the programmable transactions [example](https://github.com/MystenLabs/sui/bl ### Tic Tac Toe quick start 1. Prepare the environment - 1. Install `sui` binary following the [Sui installation](https://github.com/MystenLabs/sui/blob/main/doc/src/build/install.md##install-sui-binaries) docs. - 1. [Connect to Sui Devnet](https://github.com/MystenLabs/sui/blob/main/doc/src/build/connect-sui-network.md). - 1. [Make sure you have two addresses with gas](https://github.com/MystenLabs/sui/blob/main/doc/src/build/cli-client.md#add-existing-accounts-to-clientyaml) by using the `new-address` command to create new addresses: + 1. Install `sui` binary following the [Sui installation](https://github.com/MystenLabs/sui/blob/main/docs/content/guides/developer/getting-started/sui-install.mdx) docs. + 1. [Connect to Sui Devnet](https://github.com/MystenLabs/sui/blob/main/docs/content/guides/developer/getting-started/connect.mdx). + 1. [Make sure you have two addresses with gas](https://github.com/MystenLabs/sui/blob/main/docs/content/guides/developer/getting-started/get-address.mdx) by using the `new-address` command to create new addresses: ```shell sui client new-address ed25519 ``` You must specify the key scheme, one of `ed25519` or `secp256k1` or `secp256r1`. You can skip this step if you are going to play with a friend. :) - 1. [Request Sui tokens](https://github.com/MystenLabs/sui/blob/main/doc/src/build/install.md#sui-tokens) for all addresses that will be used to join the game. + 1. [Request Sui tokens](https://github.com/MystenLabs/sui/blob/main/docs/content/guides/developer/getting-started/get-coins.mdx) for all addresses that will be used to join the game. 2. Publish the move contract - 1. [Download the Sui source code](https://github.com/MystenLabs/sui/blob/main/doc/src/build/install.md#source-code). + 1. [Download the Sui source code](https://github.com/MystenLabs/sui/blob/main/docs/content/guides/developer/getting-started/sui-install.mdx). 1. Publish the [`games` package](https://github.com/MystenLabs/sui/tree/main/sui_programmability/examples/games) using the Sui client: ```shell diff --git a/crates/sui-types/src/README.md b/crates/sui-types/src/README.md index 410fd7f4f5404..429d160fe6809 100644 --- a/crates/sui-types/src/README.md +++ b/crates/sui-types/src/README.md @@ -3,7 +3,7 @@ Note: this README file currently covers cryptography-related structs and methods. Currently, three files are equipped with signature and hashing functionality (`crypto.rs`, `signature_seed` and -`messages.rs`). See [Sui Signatures](../../../doc/src/learn/cryptography/sui-signatures.md) for supported signature schemes and its requirments for user and authority signatures. See [fastcrypto](https://github.com/MystenLabs/fastcrypto) for concrete implementation of various cryptography libraries. +`messages.rs`). See [Sui Signatures](https://github.com/MystenLabs/sui/blob/main/docs/content/concepts/cryptography/transaction-auth/signatures.mdx) for supported signature schemes and its requirments for user and authority signatures. See [fastcrypto](https://github.com/MystenLabs/fastcrypto) for concrete implementation of various cryptography libraries. ## Quick links diff --git a/sdk/typescript/README.md b/sdk/typescript/README.md index 51c715dbe9f62..db3852d5600fc 100644 --- a/sdk/typescript/README.md +++ b/sdk/typescript/README.md @@ -5,20 +5,20 @@ For more complete docs, visit the [Sui TypeScript SDK docs](https://sdk.mystenla # Sui TypeScript SDK This is the Sui TypeScript SDK built on the Sui -[JSON RPC API](https://github.com/MystenLabs/sui/blob/main/doc/src/build/json-rpc.md). It provides -utility classes and functions for applications to sign transactions and interact with the Sui -network. +[JSON RPC API](https://github.com/MystenLabs/sui/blob/main/docs/content/references/sui-api.mdx). It +provides utility classes and functions for applications to sign transactions and interact with the +Sui network. WARNING: Note that we are still iterating on the RPC and SDK API before TestNet, therefore please expect frequent breaking changes in the short-term. We expect the API to stabilize after the upcoming TestNet launch. -## Working with DevNet +## Working with Devnet The SDK will be published to [npm registry](https://www.npmjs.com/package/@mysten/sui.js) with the -same bi-weekly release cycle as the DevNet validators and -[RPC Server](https://github.com/MystenLabs/sui/blob/main/doc/src/build/json-rpc.md). To use the SDK -in your project, you can do: +same bi-weekly release cycle as the Devnet validators and +[RPC Server](https://github.com/MystenLabs/sui/blob/main/docs/content/references/sui-api.mdx). To +use the SDK in your project, you can do: ```bash $ npm install @mysten/sui.js @@ -37,7 +37,8 @@ contain the latest changes from `main`. npm install @mysten/sui.js@experimental ``` -Refer to the [JSON RPC](https://github.com/MystenLabs/sui/blob/main/doc/src/build/json-rpc.md) topic +Refer to the +[JSON RPC](https://github.com/MystenLabs/sui/blob/main/docs/content/references/sui-api.mdx) topic for instructions about how to start a local network and local RPC server. ## Building Locally @@ -92,7 +93,7 @@ Some more follow up here is if you used homebrew to install node, there could be node on your machine. https://stackoverflow.com/questions/52676244/node-version-not-updating-after-nvm-use-on-mac -To run E2E tests against DevNet +To run E2E tests against Devnet ``` VITE_FAUCET_URL='https://faucet.devnet.sui.io:443/gas' VITE_FULLNODE_URL='https://fullnode.devnet.sui.io' pnpm --filter @mysten/sui.js exec vitest e2e @@ -104,7 +105,7 @@ The `SuiClient` class provides a connection to the JSON-RPC Server and should be read-only operations. The default URLs to connect with the RPC server are: - local: http://127.0.0.1:9000 -- DevNet: https://fullnode.devnet.sui.io +- Devnet: https://fullnode.devnet.sui.io ```typescript import { getFullnodeUrl, SuiClient } from '@mysten/sui.js/client';