restructure and refine Vaults docs#114
Open
ulieth wants to merge 6 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures and refreshes the Vaults documentation set by replacing the old “Customization” and “Meta Vaults” pages with clearer “Vault Types” and “Configuration” docs, while updating cross-doc links and rewriting several Vault concept pages for improved clarity and navigation.
Changes:
- Replaced
/docs/vaults/customizationand/docs/vaults/meta-vaultscontent with new/docs/vaults/configurationand/docs/vaults/vault-typesdocs, and updated the Vaults sidebar accordingly. - Updated staker/operator docs to point to the new Vault docs locations (including anchors), and added client redirects for legacy URLs.
- Refined multiple Vault pages (How Vaults Work, Boost, Technical Architecture, Vault Performance) and updated the custom StakeWise admonition icon asset reference.
Reviewed changes
Copilot reviewed 19 out of 30 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| staker/simple-staking.mdx | Updates Meta Vault doc link to the new “Vault Types” page anchor. |
| staker/risks.mdx | Updates Boost safety link anchor to match the revised Boost doc structure. |
| staker/rewards.mdx | Updates Smoothing Pool link to the new “Configuration” page anchor. |
| src/theme/Admonition/Types.js | Switches the custom-stakewise admonition icon to sw_logo.gif. |
| sidebars.ts | Reorders Vault docs and replaces removed pages with vault-types + configuration. |
| redirects.ts | Adds redirects from removed Vault doc routes to their replacements. |
| operator/meta-vault/overview.mdx | Updates Meta Vault link to the new “Vault Types” anchor. |
| operator/meta-vault/create-meta-vault.mdx | Updates capacity link to the new “Configuration” page anchor. |
| operator/introduction.mdx | Updates MEV strategy link to the new “Configuration” page anchor. |
| operator/create-regular-vault.mdx | Updates capacity/MEV strategy links to the new “Configuration” page anchors. |
| docs/docs/vaults/vault-types.mdx | New doc introducing and explaining Vault variants, including MetaVaults. |
| docs/docs/vaults/vault-performance.mdx | Rewrites/streamlines performance scoring explanation and presentation. |
| docs/docs/vaults/technical-architecture.mdx | Rewrites architecture overview with clearer deployment/module explanations. |
| docs/docs/vaults/meta-vaults.mdx | Removes standalone Meta Vaults page (content moved into Vault Types). |
| docs/docs/vaults/intro.mdx | Refreshes the Vaults landing page copy and adds glossary Tooltip usage. |
| docs/docs/vaults/how-vaults-work.mdx | Restructures the page into deposits/registration/rewards/withdrawals with diagrams. |
| docs/docs/vaults/customization.mdx | Removes old customization page (replaced by Configuration + Vault Types). |
| docs/docs/vaults/configuration.mdx | New doc describing immutable parameters, roles, branding, and fees. |
| docs/docs/vaults/boost.mdx | Rewrites Boost overview with clearer mechanics, safety framing, and links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
cyc60
reviewed
May 28, 2026
| The Vault's name, description, and image. Set and updated on the Vault page under **Settings → Branding**. | ||
|
|
||
| :::custom-stakewise[Authenticity Guarantee] | ||
| Before Vault branding appears in the StakeWise interface, the StakeWise team manually verifies that the operator controls the Vault. This prevents impersonation — a Vault displayed as "Operator A" is always controlled and run by Operator A. |
Contributor
There was a problem hiding this comment.
Branching updates appear instantly. The Stakewise team only manages the vault verification label.
So if you update or create new branding, you will see the following label:
Unverified Vault
The Vault owner has not been verified. Please conduct your own research before staking.
Contributor
There was a problem hiding this comment.
Settings term (mutable category) is too wide. Let's be specific:
- branding
- vault fee
- roles
|
|
||
| ### MEV Strategy | ||
|
|
||
| <Image img={require('./img/mev_strategy.png')} alt="Vault MEV strategy options - Smoothing Pool vs Own Escrow" /> |
Contributor
There was a problem hiding this comment.
Smoothing pool picture as opposed to own mev picture does not include mev relays. But it still gets rewards from relays. I would replace upper row of vaults with a row of relays, same as own mev picture.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: ulieth <uliana.eth@proton.me>
|
|
||
| There is also a special type — the **MetaVault** — which doesn't run validators itself but delegates staking to underlying sub-vaults. Like the Standard Vault, it can layer on the same tokenization (**ERC-20**) and whitelist (**Private**) modules. | ||
|
|
||
| Every Vault supports optional osETH minting via the [`VaultOsToken`](../../contracts/api/vaults/modules/VaultOsToken) module, letting depositors [mint osETH](/staker/vault-staking) against their staked position without unstaking. |
Contributor
There was a problem hiding this comment.
That 'without unstaking' ending looks like torn out from another sentence. Maybe 'against their staked position as collateral' ?
|
|
||
| <Image img={require('./img/MetaVaults_Architecture_Diagram.png')} alt="MetaVaults Architecture Diagram" /> | ||
|
|
||
| A MetaVault is a specialized Vault that doesn't run validators itself. Instead, it accepts deposits and routes them across a set of underlying Vaults — called *sub-vaults* — which handle validator operations. Just like with a regular Vault, stakers can mint osETH against their position and redeem it for the underlying stake at any time. |
Contributor
There was a problem hiding this comment.
stakers can mint osETH .. and redeem ...
Typically we use 'burn' word as opposite for minting. Redemptions is another feature, not released yet.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.