Skip to content

Commit f9608f9

Browse files
fasskofassko
authored
feat(docs): organize developer guides and reference (#956)
1 parent 0f83985 commit f9608f9

8 files changed

+184
-8
lines changed

‎docs/fassets/9-reference.mdx‎

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,68 @@ import Reference from "/src/components/FAssets/Reference";
2727

2828
## References
2929

30-
<DocCardList />
30+
### Core Interfaces
31+
32+
Smart contract interfaces for interacting with the FAssets system.
33+
34+
<DocCardList
35+
items={[
36+
{
37+
type: "link",
38+
label: "IAssetManager",
39+
href: "/fassets/reference/IAssetManager",
40+
docId: "fassets/reference/IAssetManager",
41+
},
42+
{
43+
type: "link",
44+
label: "IAssetManagerController",
45+
href: "/fassets/reference/IAssetManagerController",
46+
docId: "fassets/reference/IAssetManagerController",
47+
},
48+
{
49+
type: "link",
50+
label: "IAssetManagerEvents",
51+
href: "/fassets/reference/IAssetManagerEvents",
52+
docId: "fassets/reference/IAssetManagerEvents",
53+
},
54+
{
55+
type: "link",
56+
label: "ICollateralPool",
57+
href: "/fassets/reference/ICollateralPool",
58+
docId: "fassets/reference/ICollateralPool",
59+
},
60+
{
61+
type: "link",
62+
label: "ICoreVaultManager",
63+
href: "/fassets/reference/ICoreVaultManager",
64+
docId: "fassets/reference/ICoreVaultManager",
65+
},
66+
{
67+
type: "link",
68+
label: "IAgentOwnerRegistry",
69+
href: "/fassets/reference/IAgentOwnerRegistry",
70+
docId: "fassets/reference/IAgentOwnerRegistry",
71+
},
72+
]}
73+
/>
74+
75+
### Bot Documentation
76+
77+
Guides for running and managing FAssets bots.
78+
79+
<DocCardList
80+
items={[
81+
{
82+
type: "link",
83+
label: "Agent Bot",
84+
href: "/fassets/reference/agent-bot",
85+
docId: "fassets/reference/agent-bot",
86+
},
87+
{
88+
type: "link",
89+
label: "User Bot",
90+
href: "/fassets/reference/user-bot",
91+
docId: "fassets/reference/user-bot",
92+
},
93+
]}
94+
/>

‎docs/fassets/developer-guides.mdx‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
title: Developer Guides
3+
description: Step-by-step guides for building with FAssets
4+
keywords: [fassets, developer, guides, minting, redemption, flare-network]
5+
---
6+
7+
import DocCardList from "@theme/DocCardList";
8+
9+
Step-by-step guides for integrating and building with the [FAssets system](/fassets/overview) on Flare.
10+
11+
## Getting Started
12+
13+
Essential guides to begin working with FAssets.
14+
15+
<DocCardList
16+
items={[
17+
{
18+
type: "link",
19+
label: "Get Asset Manager Address",
20+
href: "/fassets/developer-guides/fassets-asset-manager-address-contracts-registry",
21+
docId:
22+
"fassets/developer-guides/fassets-asset-manager-address-contracts-registry",
23+
},
24+
{
25+
type: "link",
26+
label: "Get FXRP Token Address",
27+
href: "/fassets/developer-guides/fassets-fxrp-address",
28+
docId: "fassets/developer-guides/fassets-fxrp-address",
29+
},
30+
{
31+
type: "link",
32+
label: "Read FAssets Settings (Solidity)",
33+
href: "/fassets/developer-guides/fassets-settings-solidity",
34+
docId: "fassets/developer-guides/fassets-settings-solidity",
35+
},
36+
{
37+
type: "link",
38+
label: "Read FAssets Settings (Node.js)",
39+
href: "/fassets/developer-guides/fassets-settings-node",
40+
docId: "fassets/developer-guides/fassets-settings-node",
41+
},
42+
]}
43+
/>
44+
45+
## Minting FAssets
46+
47+
Guides for [minting FAssets](/fassets/minting) from underlying assets.
48+
49+
<DocCardList
50+
items={[
51+
{
52+
type: "link",
53+
label: "Mint FAssets",
54+
href: "/fassets/developer-guides/fassets-mint",
55+
docId: "fassets/developer-guides/fassets-mint",
56+
},
57+
{
58+
type: "link",
59+
label: "Execute Minting with Executor",
60+
href: "/fassets/developer-guides/fassets-mint-executor",
61+
docId: "fassets/developer-guides/fassets-mint-executor",
62+
},
63+
]}
64+
/>
65+
66+
## Redeeming FAssets
67+
68+
Guides for [redeeming FAssets](/fassets/redemption) back to underlying assets.
69+
70+
<DocCardList
71+
items={[
72+
{
73+
type: "link",
74+
label: "Redeem FAssets",
75+
href: "/fassets/developer-guides/fassets-redeem",
76+
docId: "fassets/developer-guides/fassets-redeem",
77+
},
78+
{
79+
type: "link",
80+
label: "Swap and Redeem FAssets",
81+
href: "/fassets/developer-guides/fassets-swap-redeem",
82+
docId: "fassets/developer-guides/fassets-swap-redeem",
83+
},
84+
{
85+
type: "link",
86+
label: "Redemption Defaults",
87+
href: "/fassets/developer-guides/fassets-redemption-default",
88+
docId: "fassets/developer-guides/fassets-redemption-default",
89+
},
90+
{
91+
type: "link",
92+
label: "Redemption Queue",
93+
href: "/fassets/developer-guides/fassets-redemption-queue",
94+
docId: "fassets/developer-guides/fassets-redemption-queue",
95+
},
96+
]}
97+
/>
98+
99+
## Agent Information
100+
101+
Guides for reading and working with agent data.
102+
103+
<DocCardList
104+
items={[
105+
{
106+
type: "link",
107+
label: "Read FAssets Agent Details",
108+
href: "/fassets/developer-guides/fassets-agent-details",
109+
docId: "fassets/developer-guides/fassets-agent-details",
110+
},
111+
]}
112+
/>

‎docs/fassets/developer-guides/1-fassets-asset-manager-address-contracts-registry.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Get FXRP Asset Manager Address
33
tags: [intermediate, fassets]
44
slug: fassets-asset-manager-address-contracts-registry
5-
description: Get FXRP asset manager address from the Flare contract registry
5+
description: Get FXRP asset manager address from registry
66
keywords: [fassets, flare-network, fxrp, asset-manager]
77
sidebar_position: 1
88
---

‎docs/fassets/developer-guides/10-fassets-redemption-default.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Monitor Redemptions & Execute Defaults
33
tags: [intermediate, fassets]
44
slug: fassets-redemption-default
5-
description: Learn how to monitor and handle redemption non-payment scenarios
5+
description: Monitor and handle redemption scenarios
66
keywords: [fassets, flare-network]
77
sidebar_position: 10
88
---

‎docs/fassets/developer-guides/2-fassets-fxrp-address.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Get FXRP Address
33
tags: [intermediate, fassets]
44
slug: fassets-fxrp-address
5-
description: Learn how to get FXRP address for interacting with the FAssets system
5+
description: Get FXRP address using the FAssets system
66
keywords: [fassets, flare-network, fxrp, asset-manager]
77
sidebar_position: 2
88
---

‎docs/fassets/developer-guides/3-fassets-settings-solidity.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Read FAssets Settings (Solidity)
33
tags: [intermediate, fassets]
44
slug: fassets-settings-solidity
5-
description: Fetch FAsset Lot Size and Value in USD (via FTSO) from a smart contract
5+
description: Fetch FAsset Lot Size and Value in USD (via FTSO)
66
keywords: [fassets, ftso, oracle, flare-time-series-oracle, flare-network, node]
77
sidebar_position: 3
88
---

‎docs/fassets/developer-guides/4-fassets-settings-node.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Read FAssets Settings (Node)
33
tags: [intermediate, fassets]
44
slug: fassets-settings-node
5-
description: Fetch FAsset Lot Size and Value in USD (via FTSO) using Node.js
5+
description: Fetch FAsset Lot Size and Value in USD (via FTSO)
66
keywords: [fassets, ftso, oracle, flare-time-series-oracle, flare-network, node]
77
sidebar_position: 4
88
---

‎sidebars.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,8 +222,8 @@ const sidebars: SidebarsConfig = {
222222
label: "Developer Guides",
223223
collapsed: true,
224224
link: {
225-
slug: "/fassets/developer-guides",
226-
type: "generated-index",
225+
type: "doc",
226+
id: "fassets/developer-guides",
227227
},
228228
items: [
229229
{ type: "autogenerated", dirName: "fassets/developer-guides" },

0 commit comments

Comments
 (0)