restructure and refine Vaults docs#114
Open
ulieth wants to merge 12 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
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: ulieth <uliana.eth@proton.me>
kiriyha
reviewed
Jul 1, 2026
kiriyha
reviewed
Jul 1, 2026
kiriyha
reviewed
Jul 1, 2026
kiriyha
reviewed
Jul 1, 2026
kiriyha
reviewed
Jul 1, 2026
kiriyha
reviewed
Jul 1, 2026
kiriyha
reviewed
Jul 1, 2026
kiriyha
reviewed
Jul 1, 2026
kiriyha
reviewed
Jul 1, 2026
kiriyha
reviewed
Jul 1, 2026
kiriyha
reviewed
Jul 1, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
reviewed
Jul 2, 2026
kiriyha
requested changes
Jul 2, 2026
kiriyha
reviewed
Jul 7, 2026
| **Automatic unboost.** As a final safeguard, when a position reaches **94.5% LTV** anyone can trigger an unboosting transaction on the holder's behalf, and the StakeWise core team monitors positions to do so when needed. Funds always remain under the holder's control, and since Boost never relies on the secondary market to repay debt, exits aren't exposed to slippage. | ||
|
|
||
| ## Risks & Limitations | ||
| Smart-contract exposure is limited to the chosen Vault's node operators and the regularly audited StakeWise and Aave contracts. |
There was a problem hiding this comment.
node operators don't cause smart contract exposure so can omit them
kiriyha
reviewed
Jul 7, 2026
|
|
||
| The technical process for registering validators involves coordination between the Operator Service and the Oracle network: | ||
| :::custom-notes[Validator Activation Waiting Times] | ||
| Activation time depends on the Consensus Layer's deposit queue, which processes deposits at a capped rate. Once a deposit clears the queue, only a short fixed delay remains before the validator can participate. |
There was a problem hiding this comment.
add link to https://www.validatorqueue.com/
kiriyha
requested changes
Jul 7, 2026
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.