Skip to content

Commit 3d7611b

Browse files
nud3lnud3l
authored
Merge pull request #105 from interlay/alexei/kintsugi-docs
feat: updated crowdloan vesting, theme, scaled image, fixed typos
2 parents 0e623a1 + 4cffe32 commit 3d7611b

5 files changed

Lines changed: 35 additions & 62 deletions

File tree

‎docs/README.md‎

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,47 @@
11
# InterBTC & Kintsugi Documentation
22

3-
## Radically Open Bitcoin for Decentralized Finance
3+
## Radically Open Bitcoin for Decentralized Finance
44

55

6-
**interBTC** is Bitcoin on any blockchain. A 1:1 Bitcoin-backed asset, fully collateralized, interoperable, and censorship-resistant. interBTC will be hosted as a Polkadot parachain and connected to Cosmos, Ethereum and other major DeFi networks.
6+
**interBTC** is Bitcoin on any blockchain. A 1:1 Bitcoin-backed asset, fully collateralized, interoperable, and censorship-resistant. interBTC will be hosted as a Polkadot parachain and connected to Cosmos, Ethereum and other major DeFi networks.
77

8-
**Kintsugi** is Interlay’s canary network for interBTC, a testnet with real economic value deployed on Kusama (Polkadot’s canary network). Kintsugi and interBTC share the same code base - with the difference that Kintsugi will be 2-3 releases ahead of interBTC with more experimental features.
8+
**Kintsugi** is Interlay’s canary network for interBTC, a testnet with real economic value deployed on Kusama (Polkadot’s canary network). Kintsugi and interBTC share the same code base - with the difference that Kintsugi will be 2-3 releases ahead of interBTC with more experimental features.
99

1010
![Cryptocurrency-backed Assets](_assets/img/CbA.jpg)
1111

1212
### Issue, Trade, and Redeem
1313

1414
The life-cycle of interBTC follows the three main protocols:
1515

16-
- **Issue:** Lock your BTC with a Vault. Pick one, or run your own. Your BTC is always safe and insured by Vault collateral.
16+
- **Issue:** Lock your BTC with a Vault. Pick one, or run your own. Your BTC is always safe and insured by Vault collateral.
1717
- **Mint:** Get interBTC at a 1:1 ration to your locked BTC.
18-
- **BTC DeFi:** Earn on your Bitcoin. Use interBTC as collateral, for lending, yield farming and more. On Polkadot, Kusama, Cosmos, Ethereum and other major DeFi platforms.
18+
- **BTC DeFi:** Earn on your Bitcoin. Use interBTC as collateral, for lending, yield farming and more. On Polkadot, Kusama, Cosmos, Ethereum and other major DeFi platforms.
1919
- **Redeem:** Redeem interBTC for actual BTC on Bitcoin - trustless and anytime you want.
2020

2121
### Radically Open & Secured by Insurance
2222

23-
What makes interBTC unique is the strict dedication to being trustless and decentralized. Users
23+
What makes interBTC unique is the strict dedication to being trustless and decentralized.
2424

25-
- **Secured by Insurance**. Vaults lock collateral on the interBTC parachain in various digital assets - in a MakerDAO-inspired multi-collateral system. If Vaults misbehave, their collateral is slashed and users reimbursed. As a user, you only trust that Bitcoin and the DeFi platform you use are secure.
25+
- **Secured by Insurance**. Vaults lock collateral on the interBTC parachain in various digital assets - in a MakerDAO-inspired multi-collateral system. If Vaults misbehave, their collateral is slashed and users reimbursed. As a user, you only trust that Bitcoin and the DeFi platform you use are secure.
2626

2727
- **Radically Open**. Anyone can become a Vault and help secure interBTC, anytime. Yes, you can run your own Vault!
2828

29-
30-
3129
## Guides
3230

33-
###### [1 Learn about Kintsugi, the canary network on Kusama - going live NOW](kintsugi/overview.md)
34-
31+
**1. [Learn about Kintsugi, the canary network on Kusama - going live NOW](kintsugi/overview.md)**
3532

36-
###### [2. Get a detailed overview of interBTC](start/overview.md)
33+
**2. [Get a detailed overview of interBTC](start/overview.md)**
3734

38-
###### [3. Issue your first interBTC](start/issue.md)
35+
**3. [Issue your first interBTC](start/issue.md)**
3936

40-
###### [4. Redeem interBTC for BTC](start/redeem.md)
37+
**4. [Redeem interBTC for BTC](start/redeem.md)**
4138

42-
###### [5. Understand how a Vault works](vault/overview.md)
39+
**5. [Understand how a Vault works](vault/overview.md)**
4340

44-
###### [6. Operate your own Vault](vault/guide.md)
41+
**6. [Operate your own Vault](vault/guide.md)**
4542

46-
###### [7. Build your own Dapps with interBTC](developers/integration.md)
43+
**7. [Build your own Dapps with interBTC](developers/integration.md)**
4744

4845
## Contributions
4946

50-
interBTC is an open-source project. We welcome contributions to the code and documentation. Feel free to checkout our [GitHub](https://github.com/interlay) or [Discord](https://discord.gg/KgCYK3MKSf).
47+
interBTC and Kintsugi are an open-source projects. We welcome contributions to the code and documentation. Feel free to checkout our [GitHub](https://github.com/interlay) and [Discord](https://discord.gg/KgCYK3MKSf).

‎docs/_sidebar.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,6 @@
4141

4242
* [Roadmap](about/roadmap.md)
4343

44+
* [Formal specification](https://spec.interlay.io/)
45+
4446
* [Glossary](glossary/glossary.md)

‎docs/custom.css‎

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
css
21

32
:root {
3+
--base-font: 12px;
4+
--theme-color :#1A0A2D;
5+
--sidebar-padding: 0 25px;
46
--primary-blue: #075ABC;
57
--secondary-teal: #1EE0D6;
68
--secondary-green: #A2E75E;
@@ -11,31 +13,6 @@ css
1113
--theme-color: var(--primary-blue);
1214
}
1315

14-
/* use this for the guide links */
15-
.markdown-section h6 {
16-
font-size: var(--heading-h3-font-size);
17-
border-bottom: 1px solid #d1d6db;
18-
cursor: pointer;
19-
display: flex;
20-
align-items: center;
21-
padding: 2rem 0 !important;
22-
font-weight: 800;
23-
letter-spacing: 0;
24-
padding-bottom: 0.02rem;
25-
margin: 0px;
26-
margin-top: 0px;
27-
text-decoration: none;
28-
text-transform: none;
29-
}
30-
31-
.markdown-section h6 > a {
32-
border-bottom: 0;
33-
color: inherit;
34-
text-decoration: none;
35-
}
36-
37-
.markdown-section h6 > a:hover {
38-
border-bottom: 0;
39-
color: var(--primary-blue);
40-
text-decoration: none;
16+
.app-name-link img {
17+
width: 5em;
4118
}

‎docs/index.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@
2929
loadSidebar: true,
3030
subMaxLevel: 2,
3131
loadNavbar: true,
32+
auto2top: true,
33+
themeColor: '#1A0A2D',
34+
mergeNavbar: true,
3235
name: 'Docs',
3336
logo: './_assets/img/InterBTC_Icon_RGB.svg',
3437
repo: 'https://github.com/interlay/interbtc-docs',

‎docs/kintsugi/crowdloans.md‎

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,34 @@
11
# The Kintsugi Crowdloan
22

33
Kintsugi participates in the Kusama parachain auctions and supports a crowdloan to enable the community to vote.
4-
To participate in the crowdloan, you need to lock your KSM and vote for Kintsugi to become a parachain.
4+
To participate in the crowdloan, you need to lock your KSM and vote for Kintsugi to become a parachain.
55

66
Below is a summary of the Kintsugi crowdloan details, as described in the [token economy whitepaper released by Kintsugi Labs](https://raw.githubusercontent.com/interlay/whitepapers/master/Kintsugi_Token_Economy.pdf).
77

8-
9-
## Hard Facts
8+
## Hard Facts
109

1110
* **Target slot: 6 - 10**
1211
* **Lease duration: 8 periods (maximum lease duration ~48 weeks)**
1312
* **Max. lockup target: 200 000 KSM**
1413

15-
#### Crowdloan Airdrop: 12%
16-
14+
### Crowdloan Airdrop: 12%
1715

18-
19-
* **Crowdloan: 10% (1 million KINT)** of the initial 4-year KINT supply
16+
* **Crowdloan: 10% (1 million KINT)** of the initial 4-year KINT supply
2017
* **Extra 2%** in-protocol airdrops for crowdloan participants who run Vaults and mint kBTC.
2118

2219
To create a proactive crowdloan process, Kintsugi features the following **special airdrops:**
2320

24-
25-
26-
* **Early**: 5% for first 3 days of crowdloan
27-
* **Referral**: 5% for the referrer and referred
21+
* **Early**: 5% for first 3 days of crowdloan
22+
* **Referral**: 5% for the referrer and referred
2823
* **Success**: up to 100 000 additional KINT if specific KSM lockup targets are achieved. See table:
2924

30-
3125
![Crowdloan Bonuses](../_assets/img/kintsugi/crowdloan_bonuses.png)
3226

33-
3427
Any KINT not used for the Core, Early, Referral and Success Airdrop will be distributed proportionally among all participants, further increasing the ratio of KINT per locked KSM.
3528

36-
## Participating in the Crowdloan
29+
## Participating in the Crowdloan
3730

38-
The crowdloan is a fully permissionless event - you make your own judgement on if and how you would like to participate.
31+
The crowdloan is a fully permissionless event - you make your own judgement on if and how you would like to participate.
3932

4033
We recommend the following ways to participate:
4134

@@ -44,4 +37,5 @@ We recommend the following ways to participate:
4437
3. Participate via partner mobile wallets.
4538

4639
### Guides
47-
Step-by-step guides incl. screenshots will be posted here shortly.
40+
41+
Step-by-step guides incl. screenshots will be posted here shortly.

0 commit comments

Comments
 (0)