Skip to content

restructure and refine Vaults docs#114

Open
ulieth wants to merge 11 commits into
mainfrom
docs/improve-vaults
Open

restructure and refine Vaults docs#114
ulieth wants to merge 11 commits into
mainfrom
docs/improve-vaults

Conversation

@ulieth

@ulieth ulieth commented May 27, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented May 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Jun 30, 2026 11:21am

Request Review

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/customization and /docs/vaults/meta-vaults content with new /docs/vaults/configuration and /docs/vaults/vault-types docs, 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.

Comment thread docs/docs/vaults/vault-performance.mdx Outdated
Comment thread docs/docs/vaults/configuration.mdx Outdated
Comment thread docs/docs/vaults/img/config.png
Comment thread docs/docs/vaults/configuration.mdx
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: ulieth <uliana.eth@proton.me>
Comment thread docs/docs/vaults/vault-types.mdx Outdated
Comment thread docs/docs/vaults/vault-types.mdx Outdated
Comment thread docs/docs/vaults/how-vaults-work.mdx
Comment thread docs/docs/vaults/how-vaults-work.mdx
Comment thread docs/docs/vaults/how-vaults-work.mdx
- Encrypt each signature share with the corresponding Oracle's public key
- Send the encrypted shares to all Oracles and receive registration signatures in return
5. Submit a transaction to the Vault contract to register the validator.
1. **Deposit queue** — the deposit joins the Consensus Layer's processing queue (`state.pending_deposits`), rate-limited to 16 deposits per epoch and a churn budget of 256 ETH per epoch, shared between activations and exits. Under heavy demand, deposits can wait weeks or months.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

explain for gnosis too

Comment thread docs/docs/vaults/how-vaults-work.mdx
Vaults can have several node operators running validators and support <Tooltip content={<><strong>Distributed Validator Technology</strong> <br /> A solution designed to overcome a single-operator trust problem by splitting a validator's private key among multiple independent operators. <br /> More on DVT - <a href="https://ethereum.org/en/staking/dvt/" className="tooltip-link" target="_blank" rel="noopener noreferrer nofollow">ethereum.org ↗</a></>}>Distributed Validator Technology</Tooltip> (DVT) to increase redundancy.
The [Pectra ↗](https://ethereum.org/en/roadmap/pectra/) upgrade ([EIP-7251 ↗](https://eips.ethereum.org/EIPS/eip-7251)) raised the maximum validator balance from 32 ETH to 2048 ETH, enabling **consolidation** — merging many `0x01` validators<sup><a href="#fn-1" id="fnref-1" style={{textDecoration: 'none'}}>1</a></sup> (capped at 32 ETH) into fewer high-balance `0x02` ones (up to 2048 ETH) to reduce infrastructure overhead and allow partial withdrawals of rewards above 32 ETH without exiting.

The Operator Service registers new validators as `0x02` by default, and existing `0x01` validators can be migrated via [consolidation](../../operator/manage-validators/consolidate-validators). When registering, it prioritizes funding existing `0x02` validators — selecting those with the highest current balance and topping them up to 2048 ETH before creating new ones.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

esli est' chto skazat' pro nash treatment 0x02 na gnosise, nado dobavit' v konce. vrode u nas net 0x02 na gno, check with Dima

Comment thread docs/docs/vaults/how-vaults-work.mdx
Comment thread docs/docs/vaults/how-vaults-work.mdx
Comment thread docs/docs/vaults/how-vaults-work.mdx
Comment thread docs/docs/vaults/how-vaults-work.mdx
Comment thread docs/docs/vaults/how-vaults-work.mdx
Comment thread docs/docs/vaults/how-vaults-work.mdx
:::custom-notes[Deep Dive]
For more details on how osToken works, see [osToken →](../ostoken/intro).
:::
Staked assets continue earning rewards until validators complete the exit. Once a validator fully exits, its balance is [swept ↗](https://ethereum.org/en/staking/withdrawals/#validator-sweeping) to the Vault and becomes claimable by users in ticket order. Exit processing time depends on Ethereum network conditions — check the current [validator queue ↗](https://www.validatorqueue.com/) for up-to-date estimates.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on the network conditions - check the current validator queue on Ethereum and Gnosis Chain for up-to-date estimates

Comment thread docs/docs/vaults/intro.mdx
Comment thread docs/docs/vaults/intro.mdx
Comment thread docs/docs/vaults/intro.mdx
Comment thread docs/docs/vaults/intro.mdx
Comment thread docs/docs/vaults/technical-architecture.mdx
Comment thread docs/docs/vaults/vault-performance.mdx
Comment thread docs/docs/vaults/vault-performance.mdx
### Attestation Rewards

85% of validator rewards come from attestations containing valuable information about consensus layer correctness and inclusion delay.
Attestations are the primary source of validator income — roughly 85% of all rewards — and pay for correct consensus votes that are included on time.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

confirm 85% number

Comment thread docs/docs/vaults/vault-types.mdx
Comment thread docs/docs/vaults/vault-types.mdx
Comment thread docs/docs/vaults/vault-types.mdx
Comment thread docs/docs/vaults/vault-types.mdx
Comment thread docs/docs/vaults/vault-types.mdx
Comment thread docs/docs/vaults/vault-types.mdx
Comment thread operator/meta-vault/create-meta-vault.mdx
Comment thread operator/create-regular-vault.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants