Skip to content

[WIP] Updated stVaults docs - #990

Draft
dry914 wants to merge 90 commits into
mainfrom
develop
Draft

[WIP] Updated stVaults docs#990
dry914 wants to merge 90 commits into
mainfrom
develop

Conversation

@dry914

@dry914 dry914 commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Improved stVaults docs.

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.

🟡 Changes recommended

The container startup command is invalid, several operational commands are inaccurate, redirects are incomplete, and published guides remain placeholders.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Reorganizes and expands stVaults documentation by audience, preserves legacy material, updates links, and adds partner basic authentication.

Changes:

  • Adds role-specific operational, architecture, and DeFi Wrapper guides.
  • Migrates legacy documentation and redirects selected old routes.
  • Adds a second basic-authenticated Docker user.
File summaries
File Description
sidebars.js Updates primary navigation labels.
run-on-lido/stvaults/vault-owners-curators-and-stakers/index.md Adds role navigation hub.
.../vault-owners-and-curators/roles-and-permissions.md Documents wrapper roles.
.../vault-owners-and-curators/non-custodial-operations.md Documents delegated operations.
.../vault-owners-and-curators/index.md Adds owner/curator index.
.../vault-owners-and-curators/health-guide.md Adds wrapper health guidance.
.../stakers/supply-withdraw.md Documents deposits and withdrawals.
.../stakers/rebalance.md Adds rebalance placeholder.
.../stakers/index.md Adds staker index.
.../stakers/emergency-guide.md Adds emergency placeholder.
.../defi-wrapper/index.md Adds wrapper navigation.
.../basic-stvaults/supply-withdraw-mint-repay.md Documents core vault operations.
.../basic-stvaults/redemptions_coverage_with_steth.md Documents redemption liquidity.
.../basic-stvaults/rebalance.md Documents rebalancing.
.../basic-stvaults/index.md Adds basic stVault index.
.../basic-stvaults/health-monitoring-guide.md Adds monitoring guidance.
.../basic-stvaults/health-emergency-guide.md Adds emergency guidance.
.../basic-stvaults/control-validators.md Documents validator controls.
.../basic-stvaults/apply-oracle-reports.md Documents oracle reports.
run-on-lido/stvaults/qualified-custodians/index.md Updates integration names.
.../qualified-custodians/fireblocks.md Updates steps and links.
.../qualified-custodians/copper.md Updates guide links.
.../qualified-custodians/cactus.md Updates guide links.
run-on-lido/stvaults/node-operators/index.md Adds operator hub.
.../defi-wrapper/update-strategy-implementation.md Documents strategy upgrades.
.../defi-wrapper/pdg-shortcut-bootstrap-guide.md Documents pool bootstrapping.
.../defi-wrapper/manage-withdrawal-queue.md Documents queue operations.
.../defi-wrapper/index.md Adds operator wrapper index.
.../basic-stvaults/validators-basics.md Documents validator fundamentals.
.../basic-stvaults/stvault-tier-and-steth-minting-limit.md Documents tiers and limits.
.../basic-stvaults/onboarded-node-operators.md Lists onboarded operators.
.../basic-stvaults/index.md Adds operator guide index.
.../basic-stvaults/consolidation.md Documents validator consolidation.
run-on-lido/stvaults/index.md Reworks documentation center.
run-on-lido/stvaults/faq.md Adds stVault FAQ.
.../concepts-and-reference/rr-limits-fees-tiers.md Adds reference placeholder.
.../concepts-and-reference/lido-v3-whitepaper.mdx Relocates and simplifies paper page.
.../concepts-and-reference/index.md Adds reference index.
.../concepts-and-reference/how-quarantine-works.md Documents quarantine behavior.
.../concepts-and-reference/exit-validators-permissions.md Documents exit permissions.
.../concepts-and-reference/audits.md Adds audit index.
.../concepts-and-reference/architecture-overview.md Adds architecture and addresses.
run-on-lido/stvaults/builders/defi-wrapper/index.md Adds wrapper builder index.
run-on-lido/stvaults/builders/basic-stvaults/index.md Adds basic builder index.
run-on-lido/stvaults-legacy/tech-documentation/pdg.md Updates source link.
.../tech-documentation/integration-overview.md Restores legacy integration guide.
.../tech-documentation/index.md Adds legacy technical index.
.../tech-documentation/consolidation.md Renames report links.
.../qualified-custodians/index.md Restores legacy custodian overview.
.../qualified-custodians/fireblocks.md Restores legacy Fireblocks guide.
.../qualified-custodians/copper.md Restores legacy Copper guide.
.../qualified-custodians/cactus.md Restores legacy Cactus guide.
.../operational-and-management-guides/voluntary-rebalancing-and-vault-closure.md Restores legacy rebalance guide.
.../operational-and-management-guides/stvault-disconnect-guide.md Renames report references.
.../operational-and-management-guides/index.md Updates legacy navigation.
.../operational-and-management-guides/health-monitoring-guide.md Restores legacy monitoring guide.
.../operational-and-management-guides/health-emergency-guide.md Restores legacy emergency guide.
.../operational-and-management-guides/applying-report-guide.md Renames and updates report guide.
run-on-lido/stvaults-legacy/index.md Adds legacy documentation hub.
.../features-and-mechanics/roles-and-permissions.md Restores legacy role reference.
.../features-and-mechanics/parameters-and-metrics.md Restores legacy metrics reference.
.../features-and-mechanics/index.md Adds legacy mechanics index.
.../features-and-mechanics/exit-validators.md Restores legacy exit reference.
.../building-guides/pooled-staking-product/withdrawals.md Updates legacy link.
.../pooled-staking-product/roles-and-permissions.md Updates legacy role link.
.../pooled-staking-product/index.md Updates legacy self-links.
.../pooled-staking-product/custom-strategy.md Updates legacy strategy links.
.../building-guides/index.md Adds legacy builder index.
.../building-guides/basic-stvault.md Corrects duration and link text.
run-on-lido/intro.md Updates whitepaper link.
docusaurus.config.js Adds migration redirects.
docs/guides/lido-tokens-integration-guide.md Updates title and stVault references.
docs/contracts/validator-consolidation-requests.md Updates consolidation link.
docs/contracts/staking-vault.md Updates related documentation.
docs/contracts/predeposit-guarantee.md Updates PDG references.
docs/contracts/operator-grid.md Updates related documentation.
docs/contracts/lazy-oracle.md Updates related documentation.
docs/contracts/dashboard.md Documents role renouncement semantics.
docker/start.sh Adds partner authentication user.
docker-compose.yml Passes partner credentials.
.env.example Documents partner credentials.
Review details

Suppressed comments (2)

run-on-lido/stvaults/vault-owners-curators-and-stakers/defi-wrapper/vault-owners-and-curators/non-custodial-operations.md:105

  • This configuration does not let the operations manager adjust the PDG policy. setPDGPolicy requires the non-delegable DEFAULT_ADMIN_ROLE, which this guide routes through the timelock, so claiming it as a day-to-day capability contradicts the documented permission split.
    run-on-lido/stvaults/vault-owners-curators-and-stakers/defi-wrapper/stakers/rebalance.md:7
  • Correct the invalid possessive “Stakers's” in the page heading.
  • Files reviewed: 88/118 changed files
  • Comments generated: 18
  • Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docusaurus.config.js
Comment thread docker/start.sh
Comment thread run-on-lido/stvaults/vault-owners-curators-and-stakers/index.md
Comment thread run-on-lido/stvaults/vault-owners-curators-and-stakers/index.md
Comment thread run-on-lido/stvaults/vault-owners-curators-and-stakers/index.md

# Reserve Ratio, Limits, Fees, and Tiers principles

TBD

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

TBD?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yes) we will complete it next week

Comment thread static/img/stvaults/builders/architecture_basic.jpg
Comment thread run-on-lido/stvaults-legacy/tech-documentation/pdg.md
Comment thread run-on-lido/stvaults/concepts-and-reference/metrics.md
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.

6 participants