Skip to content

Commit

Permalink
add meaningful sidebar positions to the example contract pages
Browse files Browse the repository at this point in the history
  • Loading branch information
ElliotFriend committed Mar 27, 2024
1 parent 5b2b185 commit bc6aeab
Show file tree
Hide file tree
Showing 18 changed files with 19 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/smart-contracts/example-contracts/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import DocCardList from "@theme/DocCardList";

The Soroban team has put together a large collection of [example contracts] to demonstrate use of the Soroban smart contracts platform. For many of these example contracts, we've written an accompanying tutorial that will walk you through the example contract and describe a bit more about its design. You can use the provided filters to find a relevant tutorial for your experience level.

The tutorials listed below are provided in a sequential manner. The first listed example contracts create a solid foundation of concepts that will be required during the later examples. While you are absolutely free to choose, read, and use any of the example contracts you like, please keep in mind that the order you see is intentional.

<DocCardList />

[example contracts]: https://github.com/stellar/soroban-examples
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/TEMPLATE.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Tutorial Template
description: A description of the tutorial that is being written.
draft: true
sidebar_position: 1000
sidebar_custom_props:
tutorial:
level: intermediate
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/alloc.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Allocator
description: Use the allocator feature to emulate heap memory in a smart contract.
sidebar_position: 80
sidebar_custom_props:
tutorial:
level: intermediate
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Batched Atomic Swaps
description: Swap a token pair among groups of authorized users.
sidebar_position: 100
sidebar_custom_props:
tutorial:
level: advanced
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/atomic-swap.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Atomic Swap
description: Swap tokens atomically between authorized users.
sidebar_position: 90
sidebar_custom_props:
tutorial:
level: advanced
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/auth.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Auth
description: Implement authentication and authorization.
sidebar_position: 50
sidebar_custom_props:
tutorial:
level: beginner
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Cross Contract Calls
description: Call a smart contract from another smart contract.
sidebar_position: 60
sidebar_custom_props:
tutorial:
level: beginner
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/custom-account.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Custom Account
description: Implement an account contract supporting multisig and custom authorization policies.
sidebar_position: 150
sidebar_custom_props:
tutorial:
level: advanced
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/custom-types.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Custom Types
description: Define your own data structures in a smart contract.
sidebar_position: 20
sidebar_custom_props:
tutorial:
level: beginner
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/deployer.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Deployer
description: Deploy and initialize a smart contract using another smart contract.
sidebar_position: 70
sidebar_custom_props:
tutorial:
level: beginner
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/errors.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Errors
description: Define and generate errors in a smart contract.
sidebar_position: 30
sidebar_custom_props:
tutorial:
level: beginner
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/events.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Events
description: Publish events from a smart contract.
sidebar_position: 10
sidebar_custom_props:
tutorial:
level: beginner
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/fuzzing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Fuzz Testing
description: Increase confidence in a contract's correctness with fuzz testing.
sidebar_position: 160
sidebar_custom_props:
tutorial:
level: advanced
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/liquidity-pool.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Liquidity Pool
description: Write a constant-product liquidity pool contract.
sidebar_position: 130
sidebar_custom_props:
tutorial:
level: intermediate
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/logging.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Logging
description: Debug a smart contract with logs.
sidebar_position: 40
sidebar_custom_props:
tutorial:
level: beginner
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Single Offer Sale
description: Make a standing offer to sell a token in exchange for another token.
sidebar_position: 120
sidebar_custom_props:
tutorial:
level: intermediate
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/timelock.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Timelock
description: Lockup some token to be claimed by another user under set conditions.
sidebar_position: 110
sidebar_custom_props:
tutorial:
level: intermediate
Expand Down
1 change: 1 addition & 0 deletions docs/smart-contracts/example-contracts/tokens.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Tokens
description: Write a CAP-46-6 compliant token contract.
sidebar_position: 140
sidebar_custom_props:
tutorial:
level: beginner
Expand Down

0 comments on commit bc6aeab

Please sign in to comment.