Skip to content

Docs/restructure navigation#75

Open
ulieth wants to merge 13 commits intomainfrom
docs/restructure-navigation
Open

Docs/restructure navigation#75
ulieth wants to merge 13 commits intomainfrom
docs/restructure-navigation

Conversation

@ulieth
Copy link
Copy Markdown
Contributor

@ulieth ulieth commented Mar 26, 2026

Goal

Restructure the operator documentation to create a clear, intuitive journey for a new Vault operator — from understanding what a Vault is, to launching the Operator Service, to ongoing management.

Design Principles

  • Operator docs as a single entry point. The sidebar now reads like a linear path: understand the role → create a Vault → launch the Operator Service → manage your Vault and validators.
  • V4 is the default. All shared pages (Manage Vault, Manage Validators, Smoothing Pool) assume V4. V4-only pages have a short admonition about the version requirement with an upgrade link.
    • V3 is compact, not duplicated. Operator Service V3 lives in its own folder with only the files that differ from V4 (prerequisites, installation, prepare operator, start operator, alternative key management). Common tasks (monitoring, rated network, vault administration, etc.) are shared. The V3 intro page links to these shared pages explicitly.
    • Manual Exit uses tabs. Since V3 (validators-exit) and V4 (exit-validators) have different commands, the page uses Tabs to show both versions in one place.

New pages

  • Becoming a Vault Operator — what a Vault is, why operate one, earnings, costs, responsibilities
  • StakeWise vs. Native Staking — what StakeWise adds on top of native staking for operators and depositors

Modified pages

  • Launch Operator Service V4 (Overview, Prerequisites, Installation, Validators Manager, Start Operator)

Open Questions

1. Guides section — who is the audience?

Currently Guides mixes staker-facing content (Staking, DeFi/Boost, Unstaking) with operator-facing content (Fee Splitter, Running a Vault). Two directions to consider:

  • Keep Guides for stakers only.
  • Keep Guides as a mixed section but make the split intentional — e.g. rename to "How-To Guides" and organize by persona (Staker / Operator subsections). The Vault creation guide could live here as a lightweight UI walkthrough, while the Operator section covers the technical infrastructure setup.
    Operator Service V3 — long-term approach

2. Operator Service V3 — long-term approach.
The current approach (V3 as a subfolder with only distinct files, sharing common pages with V4) works but has trade-offs.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 26, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Mar 27, 2026 6:41pm

Request Review

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.

1 participant