Skip to content

Commit c23dfd0

Browse files
JayJay1024JayJay1024
authored
Merge pull request #9 from helix-bridge/jay/docusaurus
Migrate to Docusaurus
2 parents e826fb3 + 9fb4fd5 commit c23dfd0

Some content is hidden

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

53 files changed

+14972
-12309
lines changed

‎.dumi/app.js

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎.dumi/tsconfig.json

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎.dumirc.ts

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.editorconfig

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎.github/workflows/deploy-dev.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
with:
2222
vercel_token: ${{ secrets.VERCEL_TOKEN }}
2323
node_version: 18
24-
dist_path: dist
24+
dist_path: build
2525
vercel_group: itering
2626
preview_output: true
2727
project_name: helix-docs

‎.github/workflows/deploy-prd.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
with:
2424
vercel_token: ${{ secrets.VERCEL_TOKEN }}
2525
node_version: 18
26-
dist_path: dist
26+
dist_path: build
2727
vercel_group: itering
2828
preview_output: true
2929
project_name: helix-docs

‎.github/workflows/deploy-stg.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
with:
2323
vercel_token: ${{ secrets.VERCEL_TOKEN }}
2424
node_version: 18
25-
dist_path: dist
25+
dist_path: build
2626
vercel_group: itering
2727
preview_output: true
2828
project_name: helix-docs

‎.gitignore

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
1-
node_modules
2-
/dist
3-
.dumi/tmp
4-
.dumi/tmp-production
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
512
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎.husky/commit-msg

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎.husky/pre-commit

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎.prettierignore

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎.prettierrc.js

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎README.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,41 @@
1-
# helix-docs
1+
# Helix Docs
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
220

321
```
4-
yarn install
5-
yarn start
22+
$ yarn build
623
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

‎babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
3+
};

‎docs/contract-addresses/_category_.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"position": 3,
3+
"label": "🔹 Contract Addresses"
4+
}

‎docs/helixbridge/mainnet.md renamed to ‎docs/contract-addresses/mainnet.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2-
group:
3-
title: 🔹 Contract Addresses
4-
order: 3
5-
order: 1
2+
sidebar_position: 1
63
---
74

5+
# Mainnet
6+
87
## Ethereum
98

109
- chainId: 1

‎docs/helixbridge/testnet.md renamed to ‎docs/contract-addresses/testnet.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2-
group:
3-
title: 🔹 Contract Addresses
4-
order: 3
5-
order: 1
2+
sidebar_position: 2
63
---
74

5+
# Testnet
6+
87
## Ethereum Sepolia
98

109
- chainId: 11155111

‎docs/index.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎docs/introduction/_category_.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"position": 1,
3+
"label": "🔹 Introduction"
4+
}

‎docs/helixbridge/what_is_helix.md renamed to ‎docs/introduction/what-is-helix.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
group:
3-
title: 🔹 Introduction
4-
order: 1
2+
sidebar_position: 1
3+
slug: /
54
---
65

6+
# What is Helix
7+
78
Helix Bridge is a fully open-source and decentralized cross-chain asset bridge. It's built on top of common messaging bridges that already exist between chains, and provides secure, fast, and low-cost cross-chain functionality for users.
89

910
## Features

‎docs/protocol/_category_.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"position": 2,
3+
"label": "🔹 Protocol"
4+
}

‎public/cba01.png renamed to ‎docs/protocol/img/cba01.png

File renamed without changes.

‎public/cba02.png renamed to ‎docs/protocol/img/cba02.png

File renamed without changes.

‎public/mapping_token.svg renamed to ‎docs/protocol/img/mapping-token.svg

File renamed without changes.

‎docs/helixbridge/liquidity_node_v2.md renamed to ‎docs/protocol/liquidity-node-v2.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
11
---
2-
group:
3-
title: 🔹 Protocol
4-
order: 2
5-
order: 2
6-
title: Liquidity Node(V2)
2+
sidebar_position: 3
73
---
84

5+
# Liquidity Node(v2)
96

10-
11-
# Protocol Overview
7+
## Protocol Overview
128

139
**This protocol can only be used when tokens are natively issued on both the source chain and the target chains, and their exchange values are equal.**
1410

1511
## LnProvider
1612

1713
This protocol establishes a liquidity provider role called the LnProvider (Liquidity Node Provider). When a user transfers tokens between two chains, the LnProvider receives tokens on one chain and transfers an equivalent amount of tokens to the user on the other chain.
1814

19-
During the cross-chain transfer process, the asset token goes through the following flow 👇: <img width="1721" alt="Snipaste_2024-01-24_17-15-36" src="https://github.com/helix-bridge/helix-docs/assets/1608576/85b70d43-70e0-4b43-83c2-2183c1551ae6">
15+
During the cross-chain transfer process, the asset token goes through the following flow 👇: <img width="1721" alt="Snipaste_2024-01-24_17-15-36" src="https://github.com/helix-bridge/helix-docs/assets/1608576/85b70d43-70e0-4b43-83c2-2183c1551ae6" />
2016

2117
1. **Source Chain: User → LnProvider**
2218

@@ -41,7 +37,7 @@ In normal circumstances, these two processes do not need to work with the messag
4137

4238
> 💡The locking of collateral occurs on the source chain, while the user’s assets receiving happens on the target chain. Both the two processes are auditable and have proofs on their respective chains.
4339
44-
<img width="1720" alt="Snipaste_2024-01-24_17-58-53" src="https://github.com/helix-bridge/helix-docs/assets/1608576/9b53c6a4-8628-4b53-9cd8-2fc35749c46b">
40+
<img width="1720" alt="Snipaste_2024-01-24_17-58-53" src="https://github.com/helix-bridge/helix-docs/assets/1608576/9b53c6a4-8628-4b53-9cd8-2fc35749c46b" />
4541

4642
### Pledged Collateral
4743

‎docs/helixbridge/liquidity_node_v3.md renamed to ‎docs/protocol/liquidity-node-v3.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
---
2-
group:
3-
title: 🔹 Protocol
4-
order: 2
5-
order: 2
6-
title: Liquidity Node(V3)
2+
sidebar_position: 2
73
---
84

5+
# Liquidity Node(v3)
6+
97
## Overview
108

119
In the v2 version of the Liquidity Node Protocol, we have implemented a collateral mechanism to protect user assets. In this v2 protocol, the amount of collateral staked by the LnProvider determines the transfer limit for a single transaction in that direction. To enhance trading depth, LnProviders must stake more collateral. However, since collateral cannot be shared across different directions, this leads to increased collateral costs. Consequently, the v2 protocol is more suitable for frequent, small-value transactions.

‎docs/helixbridge/mapping_token.md renamed to ‎docs/protocol/mapping-token.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
---
2-
group:
3-
title: 🔹 Protocol
4-
order: 2
5-
order: 1
2+
sidebar_position: 1
63
---
74

85
# XToken
@@ -27,7 +24,7 @@ XToken is crucial to Helix's Bridge as a Service (BaaS) by offering a framework
2724

2825
The CBA Model involves deploying the Backing module on the source chain and the Issuing module on the target chain. The asset registration and issuance process is completed through underlying calls to the generic cross-chain messaging channel.
2926

30-
<img src="/cba01.png" style="width:70%; height:70%; text-align:middle; margin-left:15%; margin-right:15%">
27+
![CBA Model](./img/cba01.png)
3128

3229
- **Backing**
3330

@@ -39,7 +36,7 @@ The CBA Model involves deploying the Backing module on the source chain and the
3936

4037
## Protocol
4138

42-
<img src="/mapping_token.svg" style="width:70%; height:70%; text-align:middle; margin-left:15%; margin-right:15%">
39+
![Protocol](./img/mapping-token.svg)
4340

4441
- **Asset registration**
4542

‎docs/relayer/_category_.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"position": 5,
3+
"label": "🔹 Relayer"
4+
}

‎docs/helixbridge/relayer_client.md renamed to ‎docs/relayer/client.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
2-
group:
3-
title: 🔹 Relayer
4-
order: 5
5-
order: 2
6-
title: Client
2+
sidebar_position: 1
3+
sidebar_label: Client
74
---
85

96
# Helix Relayer Client

‎docs/helixbridge/relayer_indexer.md renamed to ‎docs/relayer/indexer.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
2-
group:
3-
title: 🔹 Relayer
4-
order: 5
5-
order: 1
6-
title: Indexer
2+
sidebar_position: 3
3+
sidebar_label: Indexer
74
---
85

96
# Helix Data Indexing

‎public/register.gif renamed to ‎docs/relayer/register.gif

File renamed without changes.

‎docs/helixbridge/relayer_register.md renamed to ‎docs/relayer/register.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
---
2-
group:
3-
title: 🔹 Relayer
4-
order: 5
5-
order: 3
6-
title: Run a Relayer Node(V2)
2+
sidebar_position: 2
73
---
84

5+
# Run a Relayer Node(v2)
6+
97
## Overview
108

119
Helix is a completely open system where anyone can register as a Relayer without any barriers, contribute liquidity to the system, and earn profits. Before becoming a Relayer, you should have basic knowledge of blockchain, especially in the area of contract interaction. The code for Helix is open-source, and Relayers can either use the default code to run a Node or optimize the client according to their needs, promptly fixing any issues encountered.
@@ -49,7 +47,7 @@ Open the Helix UI and navigate to the [Relayer Dashboard](https://testnet.helixb
4947

5048
After completing the registration, you can open the `Manage` tab to view the registered information. You will notice that the status of the relayer is `Offline` because you have not ye started the relayer client. Please note that there may be some delay in the synchronization of registration information.
5149

52-
<img src="/register.gif" style="width:90%; height:30%; text-align:middle; margin-left:5%; margin-right:5%">
50+
![Register](./register.gif)
5351

5452
## Run the client
5553

@@ -92,9 +90,9 @@ The configuration information for the Relayer is stored in the file `.maintain/c
9290
```
9391

9492
- **indexer**[option]: It's the second-layer index service introduced in this [section](https://docs.helixbridge.app/helixbridge/relayer_indexer) can be accessed through the following link.
95-
<table style="width:80%">
93+
<table style={{ width: '80%' }}>
9694
<tr>
97-
<th style="width:20%">Network</th><th>URL</th>
95+
<th style={{ width: '20%' }}>Network</th><th>URL</th>
9896
</tr>
9997
<tr>
10098
<td>Testnet</td><td>https://apollo-test.helixbridge.app/graphql</td>

‎docs/user-guide/_category_.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"position": 4,
3+
"label": "🔹 User Guide"
4+
}

0 commit comments

Comments
 (0)