Skip to content

Commit 53eb719

Browse files
fasskofassko
authored
refactor(docs): update FAssets guides and sidebar structure (#1350)
1 parent 13d5fdd commit 53eb719

14 files changed

Lines changed: 127 additions & 1427 deletions

‎docs/fassets/08-emergency-pause.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ The goal is to prevent anyone from initiating new actions while allowing operati
1818

1919
#### Halted Operations
2020

21-
- **User/Agent Operations**: [minting](/fassets/minting), [redeeming](/fassets/redemption), [liquidation](/fassets/liquidation), [destroy agent](/fassets/reference/agent-bot#close-agent-vault), [collateral withdrawal](/fassets/reference/agent-bot#withdraw-vault-collateral), [exit available](/fassets/reference/agent-bot#exit-available).
22-
- **One-Step Operations**: [self mint](/fassets/reference/agent-bot#self-mint-fasset), [self close](/fassets/reference/agent-bot#self-close), [enter](/fassets/reference/agent-bot#enter-available), [create agent](/fassets/reference/agent-bot#create).
23-
- **Collateral Pool Operations**: [enter](/fassets/reference/user-bot#enter-pool), [exit](/fassets/reference/user-bot#exit-pool), [withdraw fees](/fassets/reference/agent-bot#withdraw-vault-collateral-1), [pay fee debt](/fassets/collateral#minting-fees-and-debt), [delegate pool collateral](/fassets/reference/agent-bot#delegate-pool-collateral).
21+
- **User/Agent Operations**: [minting](/fassets/minting), [redeeming](/fassets/redemption), [liquidation](/fassets/liquidation), destroy agent, collateral withdrawal, exit available.
22+
- **One-Step Operations**: self mint, self close, enter, create agent.
23+
- **Collateral Pool Operations**: enter, exit, withdraw fees, [pay fee debt](/fassets/collateral#minting-fees-and-debt), delegate pool collateral.
2424

2525
#### Use Cases
2626

‎docs/fassets/10-reference.mdx‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -76,24 +76,3 @@ Smart contract interfaces for interacting with the FAssets system.
7676
},
7777
]}
7878
/>
79-
80-
### Bot Documentation
81-
82-
Guides for running and managing FAssets bots.
83-
84-
<DocCardList
85-
items={[
86-
{
87-
type: "link",
88-
label: "Agent Bot",
89-
href: "/fassets/reference/agent-bot",
90-
docId: "fassets/reference/agent-bot",
91-
},
92-
{
93-
type: "link",
94-
label: "User Bot",
95-
href: "/fassets/reference/user-bot",
96-
docId: "fassets/reference/user-bot",
97-
},
98-
]}
99-
/>

‎docs/fassets/developer-guides.mdx‎

Lines changed: 123 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ keywords: [fassets, developer, guides, minting, redemption, flare-network]
55
---
66

77
import DocCardList from "@theme/DocCardList";
8+
import DocCard from "@theme/DocCard";
89

910
Step-by-step guides for integrating and building with the [FAssets system](/fassets/overview) on Flare.
1011

@@ -38,87 +39,131 @@ Essential guides to begin working with FAssets.
3839

3940
## Minting FAssets
4041

41-
Guides for [minting FAssets](/fassets/minting) from underlying assets.
42-
43-
<DocCardList
44-
items={[
45-
{
46-
type: "link",
47-
label: "Direct Mint FXRP",
48-
href: "/fassets/developer-guides/fassets-direct-minting",
49-
docId: "fassets/developer-guides/fassets-direct-minting",
50-
},
51-
{
52-
type: "link",
53-
label: "Direct Mint FXRP with Tag",
54-
href: "/fassets/developer-guides/fassets-direct-minting-tag",
55-
docId: "fassets/developer-guides/fassets-direct-minting-tag",
56-
},
57-
{
58-
type: "link",
59-
label: "Mint FAssets",
60-
href: "/fassets/developer-guides/fassets-mint",
61-
docId: "fassets/developer-guides/fassets-mint",
62-
},
63-
{
64-
type: "link",
65-
label: "Execute Minting with Executor",
66-
href: "/fassets/developer-guides/fassets-mint-executor",
67-
docId: "fassets/developer-guides/fassets-mint-executor",
68-
},
69-
]}
70-
/>
42+
Guides for minting FAssets from underlying assets.
43+
44+
<div className="row">
45+
<div className="col col--6 margin-bottom--lg">
46+
<DocCard
47+
tag="New"
48+
item={{
49+
type: "link",
50+
label: "Direct Mint FXRP",
51+
href: "/fassets/developer-guides/fassets-direct-minting",
52+
docId: "fassets/developer-guides/fassets-direct-minting",
53+
}}
54+
/>
55+
</div>
56+
<div className="col col--6 margin-bottom--lg">
57+
<DocCard
58+
tag="New"
59+
item={{
60+
type: "link",
61+
label: "Direct Mint FXRP with Tag",
62+
href: "/fassets/developer-guides/fassets-direct-minting-tag",
63+
docId: "fassets/developer-guides/fassets-direct-minting-tag",
64+
}}
65+
/>
66+
</div>
67+
<div className="col col--6 margin-bottom--lg">
68+
<DocCard
69+
item={{
70+
type: "link",
71+
label: "Mint FAssets",
72+
href: "/fassets/developer-guides/fassets-mint",
73+
docId: "fassets/developer-guides/fassets-mint",
74+
}}
75+
/>
76+
</div>
77+
<div className="col col--6 margin-bottom--lg">
78+
<DocCard
79+
item={{
80+
type: "link",
81+
label: "Execute Minting with Executor",
82+
href: "/fassets/developer-guides/fassets-mint-executor",
83+
docId: "fassets/developer-guides/fassets-mint-executor",
84+
}}
85+
/>
86+
</div>
87+
</div>
7188

7289
## Redeeming FAssets
7390

74-
Guides for [redeeming FAssets](/fassets/redemption) back to underlying assets.
75-
76-
<DocCardList
77-
items={[
78-
{
79-
type: "link",
80-
label: "Redeem FXRP by Amount",
81-
href: "/fassets/developer-guides/fassets-redeem-amount",
82-
docId: "fassets/developer-guides/fassets-redeem-amount",
83-
},
84-
{
85-
type: "link",
86-
label: "Redeem FXRP with Tag",
87-
href: "/fassets/developer-guides/fassets-redeem-with-tag",
88-
docId: "fassets/developer-guides/fassets-redeem-with-tag",
89-
},
90-
{
91-
type: "link",
92-
label: "Redeem FAssets",
93-
href: "/fassets/developer-guides/fassets-redeem",
94-
docId: "fassets/developer-guides/fassets-redeem",
95-
},
96-
{
97-
type: "link",
98-
label: "Swap and Redeem FAssets",
99-
href: "/fassets/developer-guides/fassets-swap-redeem",
100-
docId: "fassets/developer-guides/fassets-swap-redeem",
101-
},
102-
{
103-
type: "link",
104-
label: "Redemption Defaults",
105-
href: "/fassets/developer-guides/fassets-redemption-default",
106-
docId: "fassets/developer-guides/fassets-redemption-default",
107-
},
108-
{
109-
type: "link",
110-
label: "Redemption Queue",
111-
href: "/fassets/developer-guides/fassets-redemption-queue",
112-
docId: "fassets/developer-guides/fassets-redemption-queue",
113-
},
114-
{
115-
type: "link",
116-
label: "FAsset Auto-Redemption",
117-
href: "/fxrp/oft/fxrp-autoredeem",
118-
docId: "fxrp/oft/fassets-autoredeem",
119-
},
120-
]}
121-
/>
91+
Guides for redeeming FAssets back to underlying assets.
92+
93+
<div className="row">
94+
<div className="col col--6 margin-bottom--lg">
95+
<DocCard
96+
tag="New"
97+
item={{
98+
type: "link",
99+
label: "Redeem FXRP by Amount",
100+
href: "/fassets/developer-guides/fassets-redeem-amount",
101+
docId: "fassets/developer-guides/fassets-redeem-amount",
102+
}}
103+
/>
104+
</div>
105+
<div className="col col--6 margin-bottom--lg">
106+
<DocCard
107+
tag="New"
108+
item={{
109+
type: "link",
110+
label: "Redeem FXRP with Tag",
111+
href: "/fassets/developer-guides/fassets-redeem-with-tag",
112+
docId: "fassets/developer-guides/fassets-redeem-with-tag",
113+
}}
114+
/>
115+
</div>
116+
<div className="col col--6 margin-bottom--lg">
117+
<DocCard
118+
item={{
119+
type: "link",
120+
label: "Redeem FAssets",
121+
href: "/fassets/developer-guides/fassets-redeem",
122+
docId: "fassets/developer-guides/fassets-redeem",
123+
}}
124+
/>
125+
</div>
126+
<div className="col col--6 margin-bottom--lg">
127+
<DocCard
128+
item={{
129+
type: "link",
130+
label: "Swap and Redeem FAssets",
131+
href: "/fassets/developer-guides/fassets-swap-redeem",
132+
docId: "fassets/developer-guides/fassets-swap-redeem",
133+
}}
134+
/>
135+
</div>
136+
<div className="col col--6 margin-bottom--lg">
137+
<DocCard
138+
item={{
139+
type: "link",
140+
label: "Redemption Defaults",
141+
href: "/fassets/developer-guides/fassets-redemption-default",
142+
docId: "fassets/developer-guides/fassets-redemption-default",
143+
}}
144+
/>
145+
</div>
146+
<div className="col col--6 margin-bottom--lg">
147+
<DocCard
148+
item={{
149+
type: "link",
150+
label: "Redemption Queue",
151+
href: "/fassets/developer-guides/fassets-redemption-queue",
152+
docId: "fassets/developer-guides/fassets-redemption-queue",
153+
}}
154+
/>
155+
</div>
156+
<div className="col col--6 margin-bottom--lg">
157+
<DocCard
158+
item={{
159+
type: "link",
160+
label: "FAsset Auto-Redemption",
161+
href: "/fxrp/oft/fxrp-autoredeem",
162+
docId: "fxrp/oft/fassets-autoredeem",
163+
}}
164+
/>
165+
</div>
166+
</div>
122167

123168
## FXRP Token Interactions
124169

0 commit comments

Comments
 (0)