Skip to content

Commit 8110710

Browse files
committed
chore: update orca docs structure/nav/sidebar
docs: orca contract walkthrough
1 parent 43d8ef0 commit 8110710

File tree

12 files changed

+243
-287
lines changed

12 files changed

+243
-287
lines changed

main/.vitepress/config.mjs

+23-5
Original file line numberDiff line numberDiff line change
@@ -127,23 +127,41 @@ export default defineConfig({
127127
items: [
128128
{
129129
text: 'Key Concepts and APIs',
130-
link: '/guides/orchestration/getting-started/key-concepts',
130+
link: '/guides/orchestration/key-concepts',
131131
},
132132
{
133133
text: 'Contract Walkthroughs',
134-
link: '/guides/orchestration/getting-started/contract-walkthroughs',
134+
link: '/guides/orchestration/contract-walkthrough',
135135
items: [
136136
{
137137
text: 'Send Anywhere Example',
138-
link: '/guides/orchestration/getting-started/contract-walkthrough/send-anywhere',
138+
link: '/guides/orchestration/contract-walkthrough/send-anywhere',
139139
},
140140
{
141141
text: 'Cross-Chain Swap Example',
142-
link: '/guides/orchestration/getting-started/contract-walkthrough/cross-chain-swap',
142+
link: '/guides/orchestration/contract-walkthrough/cross-chain-swap',
143143
},
144144
{
145145
text: 'Cross-Chain Unbond Example',
146-
link: '/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond',
146+
link: '/guides/orchestration/contract-walkthrough/cross-chain-unbond',
147+
}
148+
]
149+
},
150+
{
151+
text: 'Example Orchestration DApp',
152+
link: '/guides/orchestration/orchestration-basics',
153+
items: [
154+
{
155+
text: 'Installation and Deployment',
156+
link: '/guides/orchestration/orchestration-basics/installation',
157+
},
158+
{
159+
text: 'Orca Contract walkthrough',
160+
link: '/guides/orchestration/orchestration-basics/contract',
161+
},
162+
{
163+
text: 'UI Walkthrough',
164+
link: '/guides/orchestration/orchestration-basics/ui',
147165
}
148166
]
149167
},

main/.vitepress/themeConfig/nav.js

+21-4
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,39 @@ export const nav = [
1515
},
1616
{
1717
text: 'Key Concepts and APIs',
18-
link: '/guides/orchestration/getting-started/key-concepts',
18+
link: '/guides/orchestration/key-concepts',
1919
},
2020
{
2121
text: 'Contract Walkthroughs',
2222
items: [
2323
{
2424
text: 'Send Anywhere Example',
25-
link: '/guides/orchestration/getting-started/contract-walkthrough/send-anywhere',
25+
link: '/guides/orchestration/contract-walkthrough/send-anywhere',
2626
},
2727
{
2828
text: 'Cross-Chain Swap Example',
29-
link: '/guides/orchestration/getting-started/contract-walkthrough/cross-chain-swap',
29+
link: '/guides/orchestration/contract-walkthrough/cross-chain-swap',
3030
},
3131
{
3232
text: 'Cross-Chain Unbond Example',
33-
link: '/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond',
33+
link: '/guides/orchestration/contract-walkthrough/cross-chain-unbond',
34+
}
35+
]
36+
},
37+
{
38+
text: 'Example Orchestration DApp',
39+
items: [
40+
{
41+
text: 'Installation and Deployment',
42+
link: '/guides/orchestration/orchestration-basics/installation',
43+
},
44+
{
45+
text: 'Orca Contract walkthrough',
46+
link: '/guides/orchestration/orchestration-basics/contract',
47+
},
48+
{
49+
text: 'UI Walkthrough',
50+
link: '/guides/orchestration/orchestration-basics/ui',
3451
}
3552
]
3653
},

main/guides/orchestration/getting-started/contract-walkthroughs.md renamed to main/guides/orchestration/contract-walkthrough/index.md

+2-14
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22

33
This section is designed to provide detailed explanations and insights into example orchestration smart contracts.
44

5-
In this section, we will cover three primary contracts:
5+
In this section, we will cover two primary contracts:
66

77
1. **Assets Transfer Contract**: A guide to `send-anywhere` contract that demonstrates a simple yet robust and secure way for cross-chain assets transfer.
8-
2. **Swap Contract**: A comprehensive guide to the process of swapping assets between different chains using the Agoric orchestration library.
9-
3. **Unbond Contract**: A detailed walkthrough of the unbonding and liquid staking process, highlighting the steps involved in managing cross-chain operations.
8+
2. **Unbond Contract**: A detailed walkthrough of the unbonding and liquid staking process, highlighting the steps involved in managing cross-chain operations.
109

1110
Each walkthrough will include detailed explanations of the contract code, providing insights into the mechanics and best practices of smart contract development on the Agoric platform. By the end of these walkthroughs, you should have a solid understanding of how to utilize Agoric’s tools and libraries to create robust and efficient cross-chain smart contracts.
1211

@@ -21,17 +20,6 @@ The "Send Anywhere" contract is a robust and secure solution for transferring as
2120

2221
[See Contract Overview](/guides/orchestration/getting-started/contract-walkthrough/send-anywhere)
2322

24-
## Swap Contract
25-
26-
The Swap Contract demonstrates how to swap assets between the Agoric chain and another blockchain. This example covers:
27-
28-
- Initializing and setting up the contract.
29-
- Creating and managing accounts on different chains.
30-
- Executing cross-chain asset transfers.
31-
- Handling errors and ensuring secure transactions.
32-
33-
[See Contract Overview](/guides/orchestration/getting-started/contract-walkthrough/cross-chain-swap)
34-
3523
## Unbond Contract
3624

3725
The Unbond Contract focuses on the process of unbonding staked assets and performing liquid staking. Key topics include:

main/guides/orchestration/getting-started/contract-walkthrough/cross-chain-swap.md

-259
This file was deleted.

main/guides/orchestration/getting-started/contract-walkthrough/orchestration-basics.md

-5
This file was deleted.

0 commit comments

Comments
 (0)