diff --git a/.gitbook.yaml b/.gitbook.yaml new file mode 100644 index 0000000..ff98f0a --- /dev/null +++ b/.gitbook.yaml @@ -0,0 +1 @@ +root: ./proposal/ \ No newline at end of file diff --git a/SUMMARY.md b/SUMMARY.md index 5adc918..69c680d 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -6,4 +6,4 @@ * [Bitcoin](integrations/understanding-the-bitcoin-bridge.md) * [Bitcoin L2s](integrations/bitcoin-l2s.md) * [Non-Bitcoin chains](integrations/non-bitcoin-chains.md) -* [Security Audits](security-audits.md) +* [Security Audits](security-audits.md) \ No newline at end of file diff --git a/proposal/SUMMARY.md b/proposal/SUMMARY.md new file mode 100644 index 0000000..a8ceb24 --- /dev/null +++ b/proposal/SUMMARY.md @@ -0,0 +1,37 @@ +# Table of contents + +## Overview + +* [Introduction](overview/introduction.md) +* [How XLink Bridge Works?](overview/how-xlink-works.md) +* [Supported Blockchains and Tokens](getting-started/supported-chains-and-tokens.md) + +## Getting Started + +* [Prerequisites](getting-started/prerequisites.md) +* [Using the Bridge](getting-started/using-the-brige.md) +* [Guides](getting-started/guides.md) + * [BRC-20 Bridge](getting-started/brc-20-guide.md) + * [Cross-Chain Bridge](getting-started/cross-chain-bridge.md) + +## Special Features + +* [Campaigns](special-features/campaigns.md) +* [Points](special-features/points.md) + +## Developers + +* [Technical Overview](developers/technical-overview/README.md) + * [Components](developers/technical-overview/components.md) + * [Smart Contracts](developers/technical-overview/smart-contracts.md) + * [Oracle Integration](developers/technical-overview/oracle-integration.md) + +* [Development & Integrations](developers/development-and-integrations/README.md) + * [XLink SDK](developers/development-and-integrations/sdk.md) + * [New features, Changelog, Roadmap?](developers/development-and-integrations/new-features.md) + +## Resources + +* [Glossary](resources/glossary.md) +* [FAQs](resources/faqs.md) +* [Networks](resources/networks.md) \ No newline at end of file diff --git a/proposal/developers/development-and-integrations/README.md b/proposal/developers/development-and-integrations/README.md new file mode 100644 index 0000000..e69de29 diff --git a/proposal/developers/development-and-integrations/new-features.md b/proposal/developers/development-and-integrations/new-features.md new file mode 100644 index 0000000..e69de29 diff --git a/proposal/developers/development-and-integrations/sdk.md b/proposal/developers/development-and-integrations/sdk.md new file mode 100644 index 0000000..8513c4d --- /dev/null +++ b/proposal/developers/development-and-integrations/sdk.md @@ -0,0 +1,9 @@ +# XLink API + +## Overview of the SDK + +## Example use cases + +## Response and error handling + +## Versioning for Developers \ No newline at end of file diff --git a/proposal/developers/technical-overview/README.md b/proposal/developers/technical-overview/README.md new file mode 100644 index 0000000..845b18a --- /dev/null +++ b/proposal/developers/technical-overview/README.md @@ -0,0 +1,7 @@ +# Bridge Architecture + +{% content-ref url="components.md" %} Components {% endcontent-ref %} + +{% content-ref url="smart-contracts.md" %} Smart Contracts Overview {% endcontent-ref %} + +{% content-ref url="oracle-integration.md" %} Oracle Integration {% endcontent-ref %} diff --git a/proposal/developers/technical-overview/components.md b/proposal/developers/technical-overview/components.md new file mode 100644 index 0000000..e69de29 diff --git a/proposal/developers/technical-overview/oracle-integration.md b/proposal/developers/technical-overview/oracle-integration.md new file mode 100644 index 0000000..e69de29 diff --git a/proposal/developers/technical-overview/smart-contracts.md b/proposal/developers/technical-overview/smart-contracts.md new file mode 100644 index 0000000..e69de29 diff --git a/proposal/getting-started/guides.md b/proposal/getting-started/guides.md new file mode 100644 index 0000000..707c90d --- /dev/null +++ b/proposal/getting-started/guides.md @@ -0,0 +1,5 @@ +# Guides + +{% content-ref url="brc20.md" %} BRC-20 Bridge {% endcontent-ref %} + +{% content-ref url="cross-chain.md" %} Cross-Chain Bridge {% endcontent-ref %} diff --git a/proposal/getting-started/prerequisites.md b/proposal/getting-started/prerequisites.md new file mode 100644 index 0000000..c07ca64 --- /dev/null +++ b/proposal/getting-started/prerequisites.md @@ -0,0 +1,3 @@ +# Prerequisites for using the bridge + +## Wallet \ No newline at end of file diff --git a/proposal/getting-started/supported-chains-and-tokens.md b/proposal/getting-started/supported-chains-and-tokens.md new file mode 100644 index 0000000..e69de29 diff --git a/proposal/getting-started/using-the-brige.md b/proposal/getting-started/using-the-brige.md new file mode 100644 index 0000000..9c2e4c3 --- /dev/null +++ b/proposal/getting-started/using-the-brige.md @@ -0,0 +1,5 @@ +# Using the Bridge + +## Transferring Assets Across Chains + +## How to execute a transfer \ No newline at end of file diff --git a/proposal/overview/how-xlink-works.md b/proposal/overview/how-xlink-works.md new file mode 100644 index 0000000..70dbfe8 --- /dev/null +++ b/proposal/overview/how-xlink-works.md @@ -0,0 +1,7 @@ +# How XLink Works? + +## Cross-chain transactions + +## Lock and mint mechanism + +## Liquidity and consensus management diff --git a/proposal/overview/introduction.md b/proposal/overview/introduction.md new file mode 100644 index 0000000..6bf7b95 --- /dev/null +++ b/proposal/overview/introduction.md @@ -0,0 +1,9 @@ +# Introduction + +## What is a blockchain bridge? + +## Its importance in decentralized ecosystems + +## Types of blockchain bridges + +## Versioning \ No newline at end of file diff --git a/proposal/resources/faqs.md b/proposal/resources/faqs.md new file mode 100644 index 0000000..8ff9629 --- /dev/null +++ b/proposal/resources/faqs.md @@ -0,0 +1,31 @@ +# Frequently Asked Questions (FAQs) + +## General + +High-level user questions. + +
+ + Question 1 + +
+ +
+ + Question 2 + +
+ +## Technical + +Developer-specific questions. + +
+ + Question 1 + +
+ +
+ + Question 2 \ No newline at end of file diff --git a/proposal/resources/glossary.md b/proposal/resources/glossary.md new file mode 100644 index 0000000..6af0493 --- /dev/null +++ b/proposal/resources/glossary.md @@ -0,0 +1,3 @@ +# XLink Glossary + +Common terms (such as Blockchain Bridge, Cross-chain Transaction, Relayer, etc.) \ No newline at end of file diff --git a/proposal/resources/networks.md b/proposal/resources/networks.md new file mode 100644 index 0000000..7a0d37c --- /dev/null +++ b/proposal/resources/networks.md @@ -0,0 +1,3 @@ +# Networks + +Deployed contract addresses. \ No newline at end of file diff --git a/proposal/special-features/campaigns.md b/proposal/special-features/campaigns.md new file mode 100644 index 0000000..e69de29 diff --git a/proposal/special-features/points.md b/proposal/special-features/points.md new file mode 100644 index 0000000..e69de29