Skip to content

Commit e66bf4a

Browse files
dineshpintodineshpinto
authored
fix(static): restructure static assets and fix ordering (#1083)
2 parents b8bcbc2 + 3877b35 commit e66bf4a

File tree

195 files changed

+245
-1982
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

195 files changed

+245
-1982
lines changed

‎CONTRIBUTING.md‎

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Run these locally before submitting a PR.
121121

122122
## <a id="diagrams-style-guide"></a> Diagrams style guide
123123

124-
Use these defaults to keep diagrams consistent in light/dark mode.
124+
Use these defaults to keep diagrams consistent across light and dark mode.
125125

126126
| Element | Light Mode | Dark Mode | Notes |
127127
| :----------------------- | :--------- | :-------- | :----------------------------------------------- |
@@ -135,6 +135,43 @@ Use these defaults to keep diagrams consistent in light/dark mode.
135135

136136
See the [homepage architecture diagram](https://dev.flare.network/#understand-the-architecture) for an example.
137137

138+
### Diagram location
139+
140+
- Store all static assets under `static/img/`.
141+
- **Documentation assets** that belong to a specific docs area (for example `network`, `ftso`, `fdc`) must live under `static/img/docs/<area>/`.
142+
- **Shared site assets** (used across the UI such as menu icons, logos, and general UI graphics) must live under `static/img/ui/`.
143+
- **Social icons** must live under `static/img/social-icons/`.
144+
145+
Directory layout:
146+
147+
```plaintext
148+
static/img
149+
├── docs
150+
│   ├── fassets
151+
│   ├── fdc
152+
│   ├── ftso
153+
│   ├── network
154+
│   ├── run-node
155+
│   ├── smart-accounts
156+
│   └── support
157+
├── social-icons
158+
└── ui
159+
```
160+
161+
### Diagram naming convention
162+
163+
- Use kebab-case for new files and folders.
164+
- Theme variants must use dot suffixes:
165+
- Light: `*.light.svg`
166+
- Dark: `*.dark.svg`
167+
168+
Example:
169+
170+
```plaintext
171+
ftso-architecture.light.svg
172+
ftso-architecture.dark.svg
173+
```
174+
138175
## Need Help?
139176

140177
If you get stuck or want feedback on an approach, open a [GitHub Issue](https://github.com/flare-foundation/developer-hub/issues).

‎docs/1-intro.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,8 @@ Its native data protocols - [Flare Time Series Oracle](/ftso/overview) and [Flar
183183
<ThemedImage
184184
alt="Flare Systems Protocol with enshrined FTSO and FDC."
185185
sources={{
186-
light: useBaseUrl("img/flare_architecture_light.svg"),
187-
dark: useBaseUrl("img/flare_architecture_dark.svg"),
186+
light: useBaseUrl("img/docs/flare-architecture.light.svg"),
187+
dark: useBaseUrl("img/docs/flare-architecture.dark.svg"),
188188
}}
189189
/>
190190

‎docs/fassets/1-overview.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Agents and a community-provided collateral pool ensure trustlessness through ove
3232
<ThemedImage
3333
alt="FTSO Update Architecture"
3434
sources={{
35-
light: useBaseUrl("img/fassets/flare_fassets_architecture_light.svg"),
36-
dark: useBaseUrl("img/fassets/flare_fassets_architecture_dark.svg"),
35+
light: useBaseUrl("img/docs/fassets/flare_fassets_architecture_light.svg"),
36+
dark: useBaseUrl("img/docs/fassets/flare_fassets_architecture_dark.svg"),
3737
}}
3838
/>
3939

‎docs/fassets/2-minting.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Any user can mint FAssets.
1919
<ThemedImage
2020
alt="FAssets Minting Process"
2121
sources={{
22-
light: useBaseUrl("img/fassets/flare_fassets_minting_light.svg"),
23-
dark: useBaseUrl("img/fassets/flare_fassets_minting_dark.svg"),
22+
light: useBaseUrl("img/docs/fassets/flare_fassets_minting_light.svg"),
23+
dark: useBaseUrl("img/docs/fassets/flare_fassets_minting_dark.svg"),
2424
}}
2525
/>
2626

‎docs/fassets/4-collateral.mdx‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,12 @@ The following thresholds are set by each agent according to their own preference
164164
<ThemedImage
165165
alt="FAssets Collateral Ratio"
166166
sources={{
167-
light: useBaseUrl("img/fassets/flare_fassets_collateral_ratio_light.svg"),
168-
dark: useBaseUrl("img/fassets/flare_fassets_collateral_ratio_dark.svg"),
167+
light: useBaseUrl(
168+
"img/docs/fassets/flare_fassets_collateral_ratio_light.svg",
169+
),
170+
dark: useBaseUrl(
171+
"img/docs/fassets/flare_fassets_collateral_ratio_dark.svg",
172+
),
169173
}}
170174
/>
171175

‎docs/fassets/5-core-vault.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
1313
alt="FAssets Core Vault Architecture"
1414
sources={{
1515
light: useBaseUrl(
16-
"img/fassets/flare_fassets_core_vault_architecture_light.svg",
16+
"img/docs/fassets/flare_fassets_core_vault_architecture_light.svg",
1717
),
1818
dark: useBaseUrl(
19-
"img/fassets/flare_fassets_core_vault_architecture_dark.svg",
19+
"img/docs/fassets/flare_fassets_core_vault_architecture_dark.svg",
2020
),
2121
}}
2222
/>

‎docs/fassets/_minting_resources.mdx‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ You can mint FAssets on either of the following dApps:
1212

1313
### Supported Wallets
1414

15-
| Wallet | <ThemedImage alt="Flare" style={{ width: "20px", height: "20px" }} sources={{ light: useBaseUrl("img/flare_icon.svg"), dark: useBaseUrl("img/flare_icon_dark.svg") }} /> | <ThemedImage alt="XRPL" style={{ width: "20px", height: "20px" }} sources={{ light: useBaseUrl("img/xrp_icon.svg"), dark: useBaseUrl("img/xrp_icon_dark.svg") }} /> | Notes |
16-
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
17-
| [Bifrost](https://bifrostwallet.com/) | ✅ | ✅ | Supports both networks. [Tutorial](https://www.youtube.com/watch?v=1lETSE9YlXQ) |
18-
| [Ledger](https://www.ledger.com/) | ✅ | ✅ | Hardware wallet supporting both networks. [Tutorial](https://youtu.be/WkdWZJJBem0) |
19-
| [Luminite](https://luminite.app/) | ✅ | ✅ | Integrated FAssets support with DeFi utilities |
20-
| [OxenFlow](https://oxenflow.io/) | ✅ | ✅ | Available via iOS app |
21-
| [MetaMask](https://metamask.io/) | ✅ | | EVM wallet for Flare transactions |
22-
| [Rabby](https://rabby.io/) | ✅ | | EVM wallet for Flare transactions |
23-
| EVM Wallets with [WalletConnect](https://walletconnect.com/) | ✅ | | Any EVM-compatible wallet supporting WalletConnect |
24-
| [Xaman](https://xaman.app/) | | ✅ | XRPL wallet only. [Tutorial](https://youtu.be/-3TPLIszPUc) |
15+
| Wallet | <ThemedImage alt="Flare" style={{ width: "20px", height: "20px" }} sources={{ light: useBaseUrl("img/ui/flare-icon.light.svg"), dark: useBaseUrl("img/ui/flare-icon.dark.svg") }} /> | <ThemedImage alt="XRPL" style={{ width: "20px", height: "20px" }} sources={{ light: useBaseUrl("img/ui/xrp-icon.light.svg"), dark: useBaseUrl("img/ui/xrp-icon.dark.svg") }} /> | Notes |
16+
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
17+
| [Bifrost](https://bifrostwallet.com/) | ✅ | ✅ | Supports both networks. [Tutorial](https://www.youtube.com/watch?v=1lETSE9YlXQ) |
18+
| [Ledger](https://www.ledger.com/) | ✅ | ✅ | Hardware wallet supporting both networks. [Tutorial](https://youtu.be/WkdWZJJBem0) |
19+
| [Luminite](https://luminite.app/) | ✅ | ✅ | Integrated FAssets support with DeFi utilities |
20+
| [OxenFlow](https://oxenflow.io/) | ✅ | ✅ | Available via iOS app |
21+
| [MetaMask](https://metamask.io/) | ✅ | | EVM wallet for Flare transactions |
22+
| [Rabby](https://rabby.io/) | ✅ | | EVM wallet for Flare transactions |
23+
| EVM Wallets with [WalletConnect](https://walletconnect.com/) | ✅ | | Any EVM-compatible wallet supporting WalletConnect |
24+
| [Xaman](https://xaman.app/) | | ✅ | XRPL wallet only. [Tutorial](https://youtu.be/-3TPLIszPUc) |
2525

2626
:::info
2727
To complete the full minting process, you may need:

‎docs/fassets/guides/2-create-fasset-agent-ui.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ authors: [fassko]
88
keywords: [fassets, xrp, btc, doge flare-network, flare-network]
99
---
1010

11-
import FAssetsAgentInterface from "/static/img/fassets/fassets-agent.png";
12-
import FAssetsAgentInterfaceAddVault from "/static/img/fassets/fassets-agent-add-vault.png";
13-
import FAssetsAgentInterfaceAddVaultForm from "/static/img/fassets/fassets-agent-add-vault-form.png";
14-
import FAssetsAgentInterfaceVaultOperations from "/static/img/fassets/fassets-agent-vault-operations.png";
11+
import FAssetsAgentInterface from "/static/img/docs/fassets/agent-ui/fassets-agent.png";
12+
import FAssetsAgentInterfaceAddVault from "/static/img/docs/fassets/agent-ui/fassets-agent-add-vault.png";
13+
import FAssetsAgentInterfaceAddVaultForm from "/static/img/docs/fassets/agent-ui/fassets-agent-add-vault-form.png";
14+
import FAssetsAgentInterfaceVaultOperations from "/static/img/docs/fassets/agent-ui/fassets-agent-vault-operations.png";
1515

1616
The FAssets Agent user interface (UI) is designed to provide a seamless and intuitive experience for users managing the FAssets agent. It allows users to monitor the agent bot and create and manage FAssets agent vaults.
1717

‎docs/fdc/1-overview.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ It allows users to submit attested data that smart contracts can trust, eliminat
3232
<ThemedImage
3333
alt="FDC Architecture Diagram"
3434
sources={{
35-
light: useBaseUrl("img/fdc-overview/fdc_architecture_light.svg"),
36-
dark: useBaseUrl("img/fdc-overview/fdc_architecture_dark.svg"),
35+
light: useBaseUrl("img/docs/fdc/overview/fdc-architecture.light.svg"),
36+
dark: useBaseUrl("img/docs/fdc/overview/fdc-architecture.dark.svg"),
3737
}}
3838
/>
3939

@@ -55,8 +55,8 @@ Operating a DA Layer is permissionless—anyone can run a DA Layer service by so
5555
<ThemedImage
5656
alt="DA Layer Diagram"
5757
sources={{
58-
light: useBaseUrl("img/fdc-overview/da_layer_light.svg"),
59-
dark: useBaseUrl("img/fdc-overview/da_layer_dark.svg"),
58+
light: useBaseUrl("img/docs/fdc/overview/da-layer.light.svg"),
59+
dark: useBaseUrl("img/docs/fdc/overview/da-layer.dark.svg"),
6060
}}
6161
/>
6262

@@ -93,8 +93,8 @@ Due to the waiting period between steps **2** and **3**, where the round is fina
9393
<ThemedImage
9494
alt="User Workflow Diagram"
9595
sources={{
96-
light: useBaseUrl("img/fdc-overview/user_workflow_light.svg"),
97-
dark: useBaseUrl("img/fdc-overview/user_workflow_dark.svg"),
96+
light: useBaseUrl("img/docs/fdc/overview/user-workflow.light.svg"),
97+
dark: useBaseUrl("img/docs/fdc/overview/user-workflow.dark.svg"),
9898
}}
9999
/>
100100

0 commit comments

Comments
 (0)