feat: structure proposal

.gitbook.yaml

@@ -0,0 +1 @@
+root: ./proposal/

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) 

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)

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

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 %}

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 %}

proposal/getting-started/prerequisites.md

@@ -0,0 +1,3 @@
+# Prerequisites for using the bridge
+
+## Wallet

proposal/getting-started/using-the-brige.md

@@ -0,0 +1,5 @@
+# Using the Bridge
+
+## Transferring Assets Across Chains
+
+## How to execute a transfer

proposal/overview/how-xlink-works.md

@@ -0,0 +1,7 @@
+# How XLink Works?
+
+## Cross-chain transactions
+
+## Lock and mint mechanism
+
+## Liquidity and consensus management

proposal/overview/introduction.md

@@ -0,0 +1,9 @@
+# Introduction
+
+## What is a blockchain bridge?
+
+## Its importance in decentralized ecosystems
+
+## Types of blockchain bridges
+
+## Versioning

proposal/resources/faqs.md

@@ -0,0 +1,31 @@
+# Frequently Asked Questions (FAQs)
+
+## General
+
+High-level user questions.
+
+<details>
+
+<summary> Question 1 </summary>
+
+</details>
+
+<details>
+
+<summary> Question 2 </summary>
+
+</details>
+
+## Technical
+
+Developer-specific questions.
+
+<details>
+
+<summary> Question 1 </summary>
+
+</details>
+
+<details>
+
+<summary> Question 2 </summary>

proposal/resources/glossary.md

@@ -0,0 +1,3 @@
+# XLink Glossary
+
+Common terms (such as Blockchain Bridge, Cross-chain Transaction, Relayer, etc.)

proposal/resources/networks.md

@@ -0,0 +1,3 @@
+# Networks
+
+Deployed contract addresses.