Skip to content

Commit

Permalink
Build out Contribute index with download instructions and description…
Browse files Browse the repository at this point in the history
…s of primary directories (MystenLabs#1076)

* Update index.md

Move `git clone` command to Contribute in prep for removal from tutorial
Add link to Install docs for getting binaries

* Update index.md

Identify, link to, and summarize contents of primary directories

* Update doc/src/contribute/index.md

Co-authored-by: Adam Welc <[email protected]>

* Update doc/src/contribute/index.md

Co-authored-by: Adam Welc <[email protected]>

* Update doc/src/contribute/index.md

Co-authored-by: Adam Welc <[email protected]>

* Update doc/src/contribute/index.md

Co-authored-by: Adam Welc <[email protected]>

Co-authored-by: Adam Welc <[email protected]>
  • Loading branch information
Clay-Mysten and awelc authored Mar 30, 2022
1 parent 3c7ef0f commit 63afa3d
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions doc/src/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Contributing to Sui
---

This page describes how to add to Sui. If you merely need to get the Sui binaries, follow [Install Sui](../build/install.md).

## File issues

Report bugs and make feature requests in the [Sui GitHub](https://github.com/MystenLabs/sui/issues) repository
Expand All @@ -16,6 +18,23 @@ You may also suggest changes to the docs directly in GitHub right here using the

Simply edit the file in question and generate a pull request. We will get back to you shortly.

## Download and learn Sui

In order to obtain the Sui source code, clone the Sui repository:

```shell
git clone https://github.com/MystenLabs/sui.git
```

You can start exploring Sui's source code by looking into the following primary directories:

* [sui](https://github.com/MystenLabs/sui/tree/main/sui) - the Sui binaries (`wallet`, `sui-move`, and more)
* [sui_programmability](https://github.com/MystenLabs/sui/tree/main/sui_programmability) - Sui's Move language integration also including games and other Move code examples for testing and reuse
* [sui_core](https://github.com/MystenLabs/sui/tree/main/sui_core) - authority server and Sui Gateway
* [sui_types](https://github.com/MystenLabs/sui/tree/main/sui_types) - coins, gas, and other object types
* [explorer](https://github.com/MystenLabs/sui/tree/main/explorer) - object explorer for the Sui network
* [network_utils](https://github.com/MystenLabs/sui/tree/main/network_utils) - networking utilities and related unit tests

## Send pull requests

Start by creating your own fork of the repo:
Expand Down

0 comments on commit 63afa3d

Please sign in to comment.