Skip to content

Commit

Permalink
examples now reference code + sui docs (MystenLabs#4036)
Browse files Browse the repository at this point in the history
  • Loading branch information
damirka authored Aug 16, 2022
1 parent 71e588b commit f5b9a62
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/book/src/LINKS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Additional Resources

To find out more about Sui Move and its usage, check out these links:

- [Sui Move examples in 'mystenLabs/sui' repo](https://github.com/MystenLabs/sui/tree/main/sui_programmability/examples)
- [How Sui Move differs from Core Move](https://docs.sui.io/learn/sui-move-diffs)
- [Why we created Sui Move](https://medium.com/mysten-labs/why-we-created-sui-move-6a234656c36b)
- [Programming with Objects on Sui](https://docs.sui.io/devnet/build/programming-with-objects)
1 change: 1 addition & 0 deletions doc/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@
- [Samples](./samples/README.md)
- [Make an NFT](./samples/nft.md)
- [Create a Coin (ERC20)](./samples/coin.md)
- [Additional Resources](./LINKS.md)
<!-- - [Make a Character](./samples/character.md) -->
4 changes: 4 additions & 0 deletions doc/book/src/patterns/hot-potato.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ Hot Potato is a name for a struct that has no abilities, hence it can only be pa
```move
{{#include ../../examples/sources/patterns/hot-potato.move:4:}}
```

This pattern is used in these examples:

- [Flash Loan](https://github.com/MystenLabs/sui/blob/main/sui_programmability/examples/defi/sources/flash_lender.move)
5 changes: 5 additions & 0 deletions doc/book/src/patterns/witness.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,8 @@ Witness is a pattern that is used for confirming the ownership of a type. To do
```move
{{#include ../../examples/sources/patterns/witness.move:4:}}
```

This pattern is used in these examples:

- [Liquidity pool](https://github.com/MystenLabs/sui/blob/main/sui_programmability/examples/defi/sources/pool.move)
- [Regulated coin](https://github.com/MystenLabs/sui/blob/main/sui_programmability/examples/fungible_tokens/sources/regulated_coin.move)

0 comments on commit f5b9a62

Please sign in to comment.