Skip to content

Commit 730f995

Browse files
authored
Merge pull request #13 from stakewise/custom-theme
Custom theme
2 parents f211191 + 93a9b41 commit 730f995

Some content is hidden

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

58 files changed

+2561
-736
lines changed

docs/docs/for-operators/05-dvt.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ There are 2 ways to create validator keys:
6060
- create keys alone
6161
- create keys with a group using Distributed Key Generation (DKG) ceremony
6262

63-
Creating keys alone may be an option if you don't collaborate with anybody. In this case DVT may be used for additional robustness. When using SSV you can fully delegate validator duties to other entities (SSV operators) and do not mind running validators on your own. See [Obol page](obol-setup.md) and [SSV page](ssv-setup.md) for further instructions if you are creating keys alone.
63+
Creating keys alone may be an option if you don't collaborate with anybody. In this case DVT may be used for additional robustness. When using SSV you can fully delegate validator duties to other entities (SSV operators) and do not mind running validators on your own. See [Obol page](../intro.mdx) and [SSV page](../intro.mdx) for further instructions if you are creating keys alone.
6464

6565
DKG is more secure and decentralized way because nobody has full control over validator keys. The document below is dedicated to DKG way.
6666

docs/docs/for-operators/migrate-from-v2/02-gnosis.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ After recovery add fake `deposit_data.json` file to your operator's vault direct
2222

2323
:::warning
2424
**If you run keys from the Verihash operator before continuing, you must import them.**
25+
2526
:::
2627

2728
This can be done with the following command:

docs/docs/protocol-overview-in-depth/02-vaults.mdx

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ All deposits, rewards distribution, and withdrawals are handled by smart contrac
3434
3535
Whenever users stake ETH into a particular Vault, that Vault contract accumulates all deposits and launches a new validator for every 32 ETH collected. 
3636
37-
[Read our guide about staking in Vaults ->](../guides/staking.md#staking-with-vaults)
37+
[Read our guide about staking in Vaults ->](../guides/01-staking.mdx#staking-with-vaults)
3838
3939
Registering new validators in the Beacon Chain can take several weeks during times when many new staking deposits are being made. ETH staked in a Vault and used to create a validator will not start producing staking rewards until the validator passes the deposit queue and becomes active. This may cause a dilution in Vault's APY. 
4040
@@ -57,15 +57,13 @@ All deposits, rewards distribution, and withdrawals are handled by smart contrac
5757
If there isn't enough unbonded ETH in the Vault, a sufficient number of Vault validators will be automatically exited to provide enough ETH for unstaking. Since exiting validators from the Beacon Chain takes time, users who requested to unstake their ETH are placed in the exit queue. Once the exit queue is over, users can claim their unstaked ETH whenever they want. 
5858
5959
Users who requested to unstake ETH from a Vault and were placed into the exit queue will continue earning staking rewards until their ETH has been exited from staking. 
60-
61-
[Read our guide about unstaking ETH from Vaults ->](vaults.md#staking-and-unstaking)
6260
</TabItem>
6361
<TabItem value="gno">
6462
**Staking and deposit queue**
6563
6664
Whenever users stake GNO into a particular Vault, that Vault contract accumulates all deposits and launches a new validator for every 1 GNO collected.&#x20;
6765
68-
[Read our guide about staking in Vaults ->](../guides/staking.md#staking-with-vaults)
66+
[Read our guide about staking in Vaults ->](../guides/01-staking.mdx#staking-with-vaults)
6967
7068
Registering new validators in the Gnosis Beacon Chain can take several weeks during times when many new staking deposits are being made. GNO staked in a Vault and used to create a validator will not start producing staking rewards until the validator passes the deposit queue and becomes active. This may cause a dilution in Vault's APY.&#x20;
7169
@@ -88,8 +86,6 @@ All deposits, rewards distribution, and withdrawals are handled by smart contrac
8886
If there isn't enough unbonded GNO in the Vault, a sufficient number of Vault validators will be automatically exited to provide enough GNO for unstaking. Since exiting validators from the Gnosis Beacon Chain takes time, users who requested to unstake their GNO are placed in the exit queue. Once the exit queue is over, users can claim their unstaked GNO whenever they want.&#x20;
8987
9088
Note that users who requested to unstake GNO from a Vault and were placed into the exit queue stop earning staking rewards as soon as they are placed in the queue.&#x20;
91-
92-
[Read our guide about unstaking GNO from Vaults ->](vaults.md#staking-and-unstaking)
9389
</TabItem>
9490
</Tabs>
9591
```
@@ -245,15 +241,11 @@ and a snapshot is taken every \~12 hours.
245241
Solo Vaults are Public or Private Vaults where the Vault Admin is both the node operator and the depositor of ETH in the Vault.&#x20;
246242
247243
Solo Vaults can be configured to a solo staker's liking, including setting the fee to the desired level, choosing between the Smoothing Pool and Own Escrow for handling of MEV, opting for a tokenless Vault to avoid potentially taxable token swaps on deposits / withdrawals, etc.
248-
249-
[Read more about configuring a Vault ->](vaults.md#for-operators-of-vaults)
250244
</TabItem>
251245
<TabItem value="gno">
252246
Solo Vaults are Public or Private Vaults where the Vault Admin is both the node operator and the depositor of GNO in the Vault.&#x20;
253247
254248
Solo Vaults can be configured to a solo staker's liking, including setting the fee to the desired level, choosing between the Smoothing Pool and Own Escrow for handling of MEV, opting for a tokenless Vault to avoid potentially taxable token swaps on deposits / withdrawals, etc.
255-
256-
[Read more about configuring a Vault ->](vaults.md#for-operators-of-vaults)
257249
</TabItem>
258250
</Tabs>
259251
```

docs/docs/protocol-overview-in-depth/03-os-token.mdx

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,6 @@ Liquid staking in StakeWise V3 is powered by osTokens - staked tokens that accru
101101
**Buying osETH on DEXs**
102102
103103
Stakers who buy osETH on DEXs don't have exposure to any particular Vault and hence are fully insulated against any slashing losses and poor performance that may occur.&#x20;
104-
105-
[Read more about the excess backing of osETH ->](ostoken.md#overcollateralization)
106104
</TabItem>
107105
<TabItem value="osgno">
108106
osGNO can be minted against any Gnosis node, including those that perform poorly.&#x20;
@@ -142,17 +140,13 @@ Liquid staking in StakeWise V3 is powered by osTokens - staked tokens that accru
142140
Redemption of osETH for ETH always happens at the underlying exchange rate between the two tokens. The exchange rate is determined by StakeWise Oracles based on the performance of Vaults.
143141
144142
Redemption of osETH for ETH is instant if there is enough unbonded ETH in the protocol. If the amount of unbonded ETH is not enough to meet the volume of redemption requests, the protocol will exit validators to withdraw a sufficient amount of ETH for full redemption.&#x20;
145-
146-
[Read more about the osETH redemption mechanism ->](ostoken.md#redemption-mechanism)
147143
</TabItem>
148144
<TabItem value="osgno">
149145
osGNO is backed by staked GNO in Vaults, and is redeemable for GNO in their validators.
150146
151147
Redemption of osGNO for GNO always happens at the underlying exchange rate between the two tokens. The exchange rate is determined by StakeWise Oracles based on the performance of Vaults.
152148
153149
Redemption of osGNO for GNO is instant if there is enough unbonded GNO in the protocol. If the amount of unbonded GNO is not enough to meet the volume of redemption requests, the protocol will exit validators to withdraw a sufficient amount of GNO for full redemption.&#x20;
154-
155-
[Read more about the osGNO redemption mechanism ->](ostoken.md#redemption-mechanism)
156150
</TabItem>
157151
</Tabs>
158152
```
@@ -493,8 +487,6 @@ Liquid staking in StakeWise V3 is powered by osTokens - staked tokens that accru
493487
494488
The amount of osETH to be burned will equal the sum of the original amount minted plus the StakeWise DAO commission, which is set to 5% of the rewards osETH accumulated.
495489
496-
[Read more about the StakeWise DAO fee ->](ostoken.md#staking-fee)
497-
498490
Note that burning the full outstanding amount of osETH is necessary to fully unstake from the Vault. If less osETH is burned, user's ETH stake will be withdrawable only partially in order to maintain appropriate position health.&#x20;
499491
500492
The amount of ETH that can be unstaked immediately will be based on position health, where the osETH position must remain healthy (i.e. up to 90% of staked ETH in 90% LTV Vaults and up to 99.99% in 99.99% LTV Vaults) after some ETH has been unstaked. This is calculated by the following formula:
@@ -535,8 +527,6 @@ Liquid staking in StakeWise V3 is powered by osTokens - staked tokens that accru
535527
536528
The amount of osGNO to be burned will equal the sum of the original amount minted plus the StakeWise DAO commission, which is set to 5% of the rewards osGNO accumulated.
537529
538-
[Read more about the StakeWise DAO fee ->](ostoken.md#staking-fee)
539-
540530
Note that burning the full outstanding amount of osGNO is necessary to fully unstake from the Vault. If less osGNO is burned, user's GNO stake will be withdrawable only partially in order to maintain appropriate position health.&#x20;
541531
542532
The amount of GNO that can be unstaked immediately will be based on position health, where the osGNO position must remain healthy (i.e. up to 90% of staked GNO in 90% LTV Vaults and up to 99.95% in 99.95% LTV Vaults) after some GNO has been unstaked. This is calculated by the following formula:

docusaurus.config.ts

Lines changed: 84 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,151 +1,130 @@
1-
import { themes as prismThemes } from "prism-react-renderer";
2-
import type { Config } from "@docusaurus/types";
3-
import type * as Preset from "@docusaurus/preset-classic";
1+
import { themes as prismThemes } from 'prism-react-renderer'
2+
import type * as Preset from '@docusaurus/preset-classic'
3+
import type { Config } from '@docusaurus/types'
44

5-
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
65

76
const config: Config = {
8-
title: "StakeWise Docs",
9-
tagline: "Dinosaurs are cool",
10-
favicon: "img/favicon.ico",
7+
title: 'Welcome to StakeWise Docs',
8+
tagline: 'Documentation and Guides',
9+
url: 'https://docs.stakewise.io',
10+
favicon: 'img/favicon.ico',
11+
baseUrl: '/',
12+
projectName: 'docs', // Usually your repo name.
13+
organizationName: 'stakewise', // Usually your GitHub org/user name.
1114

12-
// Set the production url of your site here
13-
url: "https://docs.stakewise.io",
14-
// Set the /<baseUrl>/ pathname under which your site is served
15-
// For GitHub pages deployment, it is often '/<projectName>/'
16-
baseUrl: "/",
15+
onBrokenLinks: 'warn',
16+
onBrokenAnchors: 'throw',
17+
onDuplicateRoutes: 'throw',
18+
onBrokenMarkdownLinks: 'throw',
1719

18-
// GitHub pages deployment config.
19-
// If you aren't using GitHub pages, you don't need these.
20-
organizationName: "stakewise", // Usually your GitHub org/user name.
21-
projectName: "docs", // Usually your repo name.
22-
23-
onBrokenLinks: "warn",
24-
onBrokenMarkdownLinks: "warn",
25-
26-
// Even if you don't use internationalization, you can use this field to set
27-
// useful metadata like html lang. For example, if your site is Chinese, you
28-
// may want to replace "en" with "zh-Hans".
2920
i18n: {
30-
defaultLocale: "en",
31-
locales: ["en"],
21+
defaultLocale: 'en',
22+
locales: ['en'],
3223
},
3324

3425
presets: [
3526
[
36-
"classic",
27+
'@docusaurus/preset-classic',
3728
{
3829
docs: {
39-
sidebarPath: "./sidebars.ts",
40-
routeBasePath: "/",
41-
// Please change this to your repo.
42-
// Remove this to remove the "edit this page" links.
43-
editUrl:
44-
"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
30+
sidebarPath: './sidebars.ts',
31+
showLastUpdateTime: true,
32+
routeBasePath: '/',
33+
breadcrumbs: true,
4534
},
46-
// blog: {
47-
// showReadingTime: true,
48-
// feedOptions: {
49-
// type: ["rss", "atom"],
50-
// xslt: true,
51-
// },
52-
// // Please change this to your repo.
53-
// // Remove this to remove the "edit this page" links.
54-
// editUrl:
55-
// "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
56-
// // Useful options to enforce blogging best practices
57-
// onInlineTags: "warn",
58-
// onInlineAuthors: "warn",
59-
// onUntruncatedBlogPosts: "warn",
60-
// },
6135
theme: {
62-
customCss: "./src/css/custom.css",
36+
customCss: require.resolve('./src/css/custom.css'),
6337
},
64-
} satisfies Preset.Options,
38+
}
6539
],
6640
],
6741

42+
plugins: [
43+
'./src/plugins/tailwind-config.js',
44+
],
45+
6846
themeConfig: {
69-
// Replace with your project's social card
70-
image: "img/docusaurus-social-card.jpg",
71-
tableOfContents: { minHeadingLevel: 2, maxHeadingLevel: 5 },
47+
respectPrefersColorScheme: true,
48+
image: 'img/og-image.png',
49+
50+
docs: {
51+
sidebar: {
52+
autoCollapseCategories: true,
53+
},
54+
},
55+
7256
navbar: {
73-
title: "StakeWise Docs",
57+
title: 'StakeWise Docs',
7458
logo: {
75-
alt: "My Site Logo",
76-
src: "img/logo.svg",
59+
alt: 'StakeWise Logo',
60+
src: 'img/logo512.png',
61+
height: 32,
62+
width: 32,
63+
style: {
64+
marginRight: '12px',
65+
},
7766
},
7867
items: [
7968
{
69+
label: 'Docs',
70+
to: 'docs/intro',
8071
type: "docSidebar",
81-
sidebarId: "docsSidebar",
82-
position: "left",
83-
label: "Docs",
72+
activeBaseRegex: `/docs/`,
73+
sidebarId: 'docsSidebar',
8474
},
8575
{
86-
label: "SDK",
87-
position: "left",
88-
sidebarId: "sdkSidebar",
76+
label: 'SDK',
77+
to: '/sdk/intro',
8978
activeBaseRegex: `/sdk/`,
90-
to: "/sdk/intro",
79+
sidebarId: 'sdkSidebar',
9180
},
9281
{
93-
label: "Contracs",
94-
position: "left",
95-
sidebarId: "contractsSidebar",
82+
label: 'Contracs',
83+
to: '/contracts/intro',
9684
activeBaseRegex: `/contracts/`,
97-
to: "/contracts/intro",
85+
sidebarId: 'contractsSidebar',
9886
},
9987
{
100-
href: "https://github.com/stakewise/docs",
101-
label: "GitHub",
102-
position: "right",
88+
label: 'X',
89+
href: 'https://x.com/stakewise_io',
90+
position: 'right',
10391
},
104-
],
105-
},
106-
footer: {
107-
style: "dark",
108-
links: [
10992
{
110-
title: "Docs",
111-
items: [
112-
{
113-
label: "Docs",
114-
to: "/docs/intro",
115-
},
116-
],
93+
label: 'Discord',
94+
href: 'https://discord.com/invite/2BSdr2g',
95+
position: 'right',
11796
},
11897
{
119-
title: "Community",
120-
items: [
121-
{
122-
label: "Stack Overflow",
123-
href: "https://stackoverflow.com/questions/tagged/docusaurus",
124-
},
125-
{
126-
label: "Discord",
127-
href: "https://discordapp.com/invite/docusaurus",
128-
},
129-
{
130-
label: "X",
131-
href: "https://x.com/docusaurus",
132-
},
133-
],
98+
label: 'Telegram',
99+
href: 'https://t.me/stakewise_io',
100+
position: 'right',
134101
},
135102
{
136-
title: "More",
137-
items: [
138-
{
139-
label: "GitHub",
140-
href: "https://github.com/facebook/docusaurus",
141-
},
142-
],
143-
},
103+
type: 'html',
104+
position: 'right',
105+
value: `
106+
<button
107+
onclick="window.open('https://app.stakewise.io', '_blank')"
108+
style="padding: 10px 20px; background-color: #846ab2; color: white; border: none; border-radius: 5px; cursor: pointer;"
109+
>
110+
Go to StakeWise
111+
</button>
112+
`,
113+
}
144114
],
145-
copyright: `Copyright © ${new Date().getFullYear()} StakeWise`,
146115
},
116+
117+
tableOfContents: {
118+
minHeadingLevel: 2,
119+
maxHeadingLevel: 5,
120+
},
121+
footer: {
122+
copyright: `Copyright © ${new Date().getFullYear()} StakeWise Labs`,
123+
},
124+
147125
prism: {
148126
theme: prismThemes.github,
127+
defaultLanguage: 'typescript',
149128
darkTheme: prismThemes.dracula,
150129
},
151130
} satisfies Preset.ThemeConfig,

0 commit comments

Comments
 (0)