Skip to content

Commit 4b7d942

Browse files
committed
feat(docs): enhance developer guides with "What's next" sections
1 parent 214edea commit 4b7d942

18 files changed

+132
-21
lines changed

docs/fassets/1-overview.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,4 +128,6 @@ Movements of funds require multiple signatures and follow formal agreements, not
128128

129129
Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [redemptions](/fassets/redemption), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).
130130

131+
For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.
132+
131133
:::

docs/fassets/2-minting.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -320,3 +320,11 @@ Because self-minting is done without a collateral reservation request, in some c
320320
If one of these changes occurs, the agent can self-mint a smaller number of lots, even 0 lots, and the remainder of the deposited underlying assets is added to the free underlying balance.
321321

322322
Additionally, when agents create a vault, they can choose not to make it public, so the vault can only be used to self-mint.
323+
324+
:::tip[What's next]
325+
326+
Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [redemptions](/fassets/redemption), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).
327+
328+
For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.
329+
330+
:::

docs/fassets/3-redemption.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,11 @@ As shown in the following process, agents can self-redeem for any reason, includ
136136
4. The underlying collateral is released and can be withdrawn from the underlying address later.
137137

138138
The self-redeemed amount is not limited to a positive integer of lots and can be less than 1 lot, which makes self-closing ideal for redeeming an agent's dust.
139+
140+
:::tip[What's next]
141+
142+
Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).
143+
144+
For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.
145+
146+
:::

docs/fassets/4-collateral.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -441,3 +441,11 @@ These actions can cause the agent's CPTs to be burned:
441441
## Top-up
442442

443443
To reduce the likelihood of liquidations because the pool collateral is too low, the pool can be topped up at a reduced price when the **CR** is above the **top-up CR**. A top-up mechanism for vault collateral is not available. To prevent liquidation, agents can add vault collateral any time.
444+
445+
:::tip[What's next]
446+
447+
Learn more about the different components and processes involved in FAssets - [minting](/fassets/minting), [redemptions](/fassets/redemption), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).
448+
449+
For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.
450+
451+
:::

docs/fassets/5-core-vault.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,3 +190,11 @@ The **Core Vault** fundamentally strengthens FAssets:
190190
- **Adds layered security**, combining multisig, escrow, and governance controls.
191191

192192
It is the key to making cross-chain assets on Flare both **secure** and **efficient**.
193+
194+
:::tip[What's next]
195+
196+
Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [redemptions](/fassets/redemption) and [liquidations](/fassets/liquidation).
197+
198+
For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.
199+
200+
:::

docs/fassets/6-liquidation.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,3 +330,11 @@ The locked collateral is also ineligible for minting.
330330

331331
Agents must announce the closing of their vaults.
332332
They become unusable until the lock expires, and then they can be closed.
333+
334+
:::tip[What's next]
335+
336+
Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [redemptions](/fassets/redemption) and [Core Vault](/fassets/core-vault).
337+
338+
For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.
339+
340+
:::

docs/fassets/7-emergency-pause.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,11 @@ It completely freezes all movement of the FAssets.
6868

6969
The FAssets emergency pause system provides a robust framework for maintaining system security and stability during critical situations.
7070
The system can respond appropriately to various types of threats while maintaining essential functionality and protecting user assets.
71+
72+
:::tip[What's next]
73+
74+
Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [redemptions](/fassets/redemption), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).
75+
76+
For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.
77+
78+
:::

docs/fassets/8-operational-parameters.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,11 @@ To get the Core Vault manager operational parameters you need to use the [`ICore
6767
To get the Core Vault settings you need to use the [`IAssetManager`](/fassets/reference/IAssetManager) interface. Specific functions added to each parameter.
6868

6969
<OperationalParameters sectionTitle="Core Vault Settings" hideBtc hideDoge />
70+
71+
:::tip[What's next]
72+
73+
Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [redemptions](/fassets/redemption), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).
74+
75+
For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.
76+
77+
:::

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,18 @@ import {IAssetManager} from "@flarenetwork/flare-periphery-contracts/coston2/IAs
3131
IAssetManager assetManager = ContractRegistry.getAssetManagerFXRP();
3232
```
3333

34-
## Next Steps
34+
## Summary
3535

3636
In this guide, you learned how to get the FXRP Asset Manager address for the FAssets system by interacting with the `AssetManager` contract using the [`IAssetManager`](/fassets/reference/IAssetManager) interface.
3737

3838
You should not hardcode the FXRP Asset Manager address in your smart contracts.
3939

40+
:::tip[What's next]
41+
4042
To continue your FAssets development journey, you can:
4143

4244
- Learn how to [mint FXRP](/fassets/developer-guides/fassets-mint).
4345
- Understand how to [redeem FXRP](/fassets/developer-guides/fassets-redeem).
4446
- Explore [FAssets system settings](/fassets/operational-parameters).
47+
48+
:::

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,16 @@ Once you have the FXRP address, you can:
8585
2. Add it to your wallet to track FXRP balances
8686
3. Use it in DeFi protocols that support FXRP
8787

88-
## Next Steps
88+
## Summary
8989

9090
In this guide, you learned how to get the FXRP address for the FAssets system by interacting with the `AssetManager` contract using the [`IAssetManager`](/fassets/reference/IAssetManager) interface.
9191

92+
:::tip[What's next]
93+
9294
To continue your FAssets development journey, you can:
9395

9496
- Learn how to [mint FXRP](/fassets/developer-guides/fassets-mint).
9597
- Understand how to [redeem FXRP](/fassets/developer-guides/fassets-redeem).
9698
- Explore [FAssets system settings](/fassets/operational-parameters).
97-
- Check the [lot size](/fassets/developer-guides/fassets-settings-node) for FXRP operations.
99+
100+
:::

0 commit comments

Comments
 (0)