Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update index.md #922

Merged
merged 1 commit into from
Mar 18, 2022
Merged

Update index.md #922

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions doc/src/learn/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Sui Developer Guides
title: Learning Sui
---

Welcome to the documentation for the Sui platform. Since Sui is built upon the core [Move](https://github.com/MystenLabs/awesome-move) programming language,
you should familiarize yourself with it and use this content to apply the differences. For a summary of these differences, see
[Sui compared to other blockchains](sui-move-diffs.md).
[Sui compared to other blockchains](../learn/sui-move-diffs.md).

For a deep dive into Sui technology, see the [Sui Smart Contracts Platform](../../../paper/sui.pdf) white paper.

Expand All @@ -20,7 +20,7 @@ See the [Wallet Quick Start](../build/wallet.md) for installation, querying the

Navigate and search this site however you see fit. Here is the order we recommend if you are new to Sui:

1. Learn about Sui, how it differs from Move, and why you should employ it starting in this very section.
1. Learn [about Sui]((../learn/about-sui.md), how [Sui differs from Move](../learn/why-move.md), and [how Sui works](how-sui-works.md) starting in this very section.
1. [Build](../build/index.md) smart contracts, wallets, authorities, transactions, and more.
1. [Explore](../explore/index.md) NFTs, make transfers, and see the Sui API.
1. [Contribute](../contribute/index.md) to Sui by joining the community, making enhancements, and learning about Mysten Labs.
Expand All @@ -29,9 +29,17 @@ Navigate and search this site however you see fit. Here is the order we recommen

Take note of these related repositories of information to make best use of the knowledge here:

* Original [Move Book](https://move-book.com/index.html) written by a member of the Sui team.
* [Core Move](https://github.com/diem/move/tree/main/language/documentation) documentation, including:
* [Tutorial](https://github.com/diem/move/blob/main/language/documentation/tutorial/README.md) - A step-by-step guide through writing a Move module.
* [Book](https://github.com/diem/move/blob/main/language/documentation/book/src/introduction.md) - A summary with pages on [various topics](https://github.com/diem/move/tree/main/language/documentation/book/src).
* [Examples](https://github.com/diem/move/tree/main/language/documentation/examples/experimental) - A set of samples, such as for [defining a coin](https://github.com/diem/move/tree/main/language/documentation/examples/experimental/basic-coin) and [swapping it](https://github.com/diem/move/tree/main/language/documentation/examples/experimental/coin-swap).
* [Awesome Move](https://github.com/MystenLabs/awesome-move/blob/main/README.md) - A summary of resources related to Move, from blockchains through code samples.
* [Sui API Reference](https://app.swaggerhub.com/apis/MystenLabs/sui-api/0.1 ) - The reference files for the Sui Rest API.

## Provide feedback/make fixes

Send us documentation fixes or requests for improvement at:
doc@mystenlabs.com

You may also suggest changes to the docs directly in GitHub right here. Simply edit the file in question and generated a pull request. We will get back to you shortly.