From 29f21cbc5c9de44dc1e41ed1fb24ff13920ee158 Mon Sep 17 00:00:00 2001 From: Clay-Mysten <100217682+Clay-Mysten@users.noreply.github.com> Date: Fri, 11 Mar 2022 06:43:06 -0800 Subject: [PATCH 1/7] Create examples.md Summarize Sui code samples for easy reference and findability --- doc/src/explore/examples.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 doc/src/explore/examples.md diff --git a/doc/src/explore/examples.md b/doc/src/explore/examples.md new file mode 100644 index 0000000000000..9d803b218afc0 --- /dev/null +++ b/doc/src/explore/examples.md @@ -0,0 +1,27 @@ +--- +title: Examples of Sui +--- + +Find sample Sui implementations in the [sui_programmability/examples](../../../sui_programmability/examples) directory. Here is a rundown of existing examples. + +## Basics + +Use the [Basics](../../../sui_programmability/examples/basics) example to explore heavily commented objects and a simple exchange. + +## DeFi + +In the [DeFi](../../../sui_programmability/examples/defi) example, find an atomic swap leveraging an escrow agent that is trusted for liveness, but not safety. + +## Fungible Tokens + +In the [Fungible Tokens](../../../sui_programmability/examples/fungible_tokens) example, see a token managed by a treasurer trusted for minting and burning for +how (e.g.) a fiat-backed stablecoin would work. + +## Games + +The [Games](../../../sui_programmability/examples/games) example let's you try out and modify toy games built on top of Sui! These include classic Tic Tac Toe +and various versions of an adventure game (Hero). + +## NFTs + +In the [NFTs](../../../sui_programmability/examples/nfts) example, issue non-fungible tokens and see NFTs representing assets in a game. From 7bd9b139445b502399056183a755bdefdd850ed8 Mon Sep 17 00:00:00 2001 From: Clay-Mysten <100217682+Clay-Mysten@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:45:38 -0800 Subject: [PATCH 2/7] Update doc/src/explore/examples.md Co-authored-by: Sam Blackshear --- doc/src/explore/examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/src/explore/examples.md b/doc/src/explore/examples.md index 9d803b218afc0..776dd2e659ba8 100644 --- a/doc/src/explore/examples.md +++ b/doc/src/explore/examples.md @@ -6,7 +6,7 @@ Find sample Sui implementations in the [sui_programmability/examples](../../../s ## Basics -Use the [Basics](../../../sui_programmability/examples/basics) example to explore heavily commented objects and a simple exchange. +Use the [Basics](../../../sui_programmability/examples/basics) example to explore object creation, update, and exchange. ## DeFi From 1b8d1b1c253c48c1cadef3460bf09ce5da520b54 Mon Sep 17 00:00:00 2001 From: Clay-Mysten <100217682+Clay-Mysten@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:46:27 -0800 Subject: [PATCH 3/7] Update doc/src/explore/examples.md Co-authored-by: Sam Blackshear --- doc/src/explore/examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/src/explore/examples.md b/doc/src/explore/examples.md index 776dd2e659ba8..9491864edb8fb 100644 --- a/doc/src/explore/examples.md +++ b/doc/src/explore/examples.md @@ -19,7 +19,7 @@ how (e.g.) a fiat-backed stablecoin would work. ## Games -The [Games](../../../sui_programmability/examples/games) example let's you try out and modify toy games built on top of Sui! These include classic Tic Tac Toe +The [Games](../../../sui_programmability/examples/games) example lets you try out and modify toy games built on top of Sui! These include classic Tic Tac Toe and various versions of an adventure game (Hero). ## NFTs From 76ab33ffe3da297151de1825ec8d1fdbab35e5dd Mon Sep 17 00:00:00 2001 From: Clay-Mysten <100217682+Clay-Mysten@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:46:38 -0800 Subject: [PATCH 4/7] Update doc/src/explore/examples.md Co-authored-by: Sam Blackshear --- doc/src/explore/examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/src/explore/examples.md b/doc/src/explore/examples.md index 9491864edb8fb..17b8593def276 100644 --- a/doc/src/explore/examples.md +++ b/doc/src/explore/examples.md @@ -20,7 +20,7 @@ how (e.g.) a fiat-backed stablecoin would work. ## Games The [Games](../../../sui_programmability/examples/games) example lets you try out and modify toy games built on top of Sui! These include classic Tic Tac Toe -and various versions of an adventure game (Hero). +, rock paper scissors, and various versions of an adventure game (Hero). ## NFTs From d5095c530f7b34b57f546e970c6b587d28478c4f Mon Sep 17 00:00:00 2001 From: Clay-Mysten <100217682+Clay-Mysten@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:46:51 -0800 Subject: [PATCH 5/7] Update doc/src/explore/examples.md Co-authored-by: Sam Blackshear --- doc/src/explore/examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/src/explore/examples.md b/doc/src/explore/examples.md index 17b8593def276..0177ca69f3cb3 100644 --- a/doc/src/explore/examples.md +++ b/doc/src/explore/examples.md @@ -24,4 +24,4 @@ The [Games](../../../sui_programmability/examples/games) example lets you try ou ## NFTs -In the [NFTs](../../../sui_programmability/examples/nfts) example, issue non-fungible tokens and see NFTs representing assets in a game. +In the [NFTs](../../../sui_programmability/examples/nfts) example, browse non-fungible tokens of various types and see NFTs representing assets in a game. From 6280b9c3915033ac6ac361ad6e5363e1aba6f82e Mon Sep 17 00:00:00 2001 From: Clay-Mysten <100217682+Clay-Mysten@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:47:01 -0800 Subject: [PATCH 6/7] Update doc/src/explore/examples.md Co-authored-by: Sam Blackshear --- doc/src/explore/examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/src/explore/examples.md b/doc/src/explore/examples.md index 0177ca69f3cb3..002a3a816fc44 100644 --- a/doc/src/explore/examples.md +++ b/doc/src/explore/examples.md @@ -1,5 +1,5 @@ --- -title: Examples of Sui +title: Examples of Sui Smart Contracts --- Find sample Sui implementations in the [sui_programmability/examples](../../../sui_programmability/examples) directory. Here is a rundown of existing examples. From 54bae11aaebac347cbbcfbb18de661084aedac72 Mon Sep 17 00:00:00 2001 From: Clay-Mysten <100217682+Clay-Mysten@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:47:11 -0800 Subject: [PATCH 7/7] Update doc/src/explore/examples.md Co-authored-by: Sam Blackshear --- doc/src/explore/examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/src/explore/examples.md b/doc/src/explore/examples.md index 002a3a816fc44..e7919568609a6 100644 --- a/doc/src/explore/examples.md +++ b/doc/src/explore/examples.md @@ -2,7 +2,7 @@ title: Examples of Sui Smart Contracts --- -Find sample Sui implementations in the [sui_programmability/examples](../../../sui_programmability/examples) directory. Here is a rundown of existing examples. +Find sample Sui smart contract implementations in the [sui_programmability/examples](../../../sui_programmability/examples) directory. Here is a rundown of existing examples. ## Basics