feat: Initial integration docs #140
Conversation
| @@ -5,6 +5,10 @@ | |||
| </p> | |||
| <br/> | |||
|
|
|||
| ## Overview | |||
|
|
|||
| The Babylon Wallet Connector provides a unified interface for integrating both Bitcoin (BTC) and Babylon (BBN) wallets into Babylon dApp. It supports both native wallet extensions and injectable mobile wallets. | |||
There was a problem hiding this comment.
"native wallet extensions" & "injectable mobile wallets" might be confusing for people outside of the company.
How about have a small section dedicate to explain what this really mean? and especially for the mobile injectable, give a small example with screenshot
|
|
||
| ### Integration Through Tomo Connect SDK Lite | ||
|
|
||
| In addition to direct integration, wallets can also be integrated through [Tomo Connect SDK Lite](https://docs.tomo.inc/tomo-sdk/tomo-connect-sdk-lite). |
There was a problem hiding this comment.
IMO we shall put this section first as we would like to delegate this to tomo as much as possible. i.e encourage wallet to go through tomo. if it doesn't work out due to xyz reason, come to us
|
|
||
| This guide explains how to integrate wallets with the Babylon staking dApp. The dApp supports both Bitcoin (BTC) and Babylon (BBN) wallets through a unified interface. | ||
|
|
||
| ### Supported Wallet Types |
There was a problem hiding this comment.
Let's not put everything under a single README.
We can start with the high-level file structure first then gradually define the content.
Something on top of my head:
- README.md: table of content of below points from "doc" directly. The rest can just be local dev instruction on how to spin up playbook, how to run tests etc.
- doc
- bitcoin: instruction on how to get listed as part of the bitcoin wallets
- babylon: instruction on how to get listed as part of the BBN wallets
- mobile: instruction on how to work with mobile injectable where both BTC & BBN need to be implemented
- General guideline: This page highlights the rules wallets should follow before and after integration. For example, no breaking change, provide POC for incident etc. We can also put this as first line of the main README.md
- FAQs: A list of common questions that were asked by wallets
Note: no need to go detail into each section at this stage. I'm just highlighting we shall start with skeleton on the structure and areas we want to cover. The actual content can be added later on.
thoughts on the structure? @totraev @jeremy-babylonlabs @vitsalis
Initial integration docs
Closes #16