Skip to content

Docs/restructure navigation#75

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

Docs/restructure navigation#75
ulieth wants to merge 16 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 Error Error Apr 1, 2026 0:26am

Request Review


Your costs depend on whether you run your own node or delegate operations to a third party. If you run the node yourself:

- **Infrastructure** — Hardware requirements are an ever-evolving target. As of March 2026, running a node requires a dedicated machine with at least 64 GB, a 4TB SSD, and a stable internet connection. You can use a pre-built staking hardware (from ~€2,000 for plug-and-play devices such as [Home x StakeWise Pro ↗](https://shop.dappnode.io/product/home-x-stakewise-pro/)) or a cloud server if you don't want to deal with building and maintaining your own physical computer.
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.

Suggested change
- **Infrastructure** — Hardware requirements are an ever-evolving target. As of March 2026, running a node requires a dedicated machine with at least 64 GB, a 4TB SSD, and a stable internet connection. You can use a pre-built staking hardware (from ~€2,000 for plug-and-play devices such as [Home x StakeWise Pro ↗](https://shop.dappnode.io/product/home-x-stakewise-pro/)) or a cloud server if you don't want to deal with building and maintaining your own physical computer.
- **Infrastructure** — Hardware requirements are an ever-evolving target. As of March 2026, running a node requires a dedicated machine with at least 64 GB, a 4TB SSD, and a stable internet connection. You can use a pre-built staking hardware i.e. [Home x StakeWise Pro ↗](https://dappnode.com/collections/staking-collection/products/dappnode-home-x-stakewise-pro) or a cloud server if you don't want to deal with building and maintaining your own physical computer.


## Who Operates Vaults Today

Vault operators range from solo stakers running a single private Vault to professional node operators and institutions managing thousands of ETH. StakeWise infrastructure powers staking products for partners like [MetaMask ↗](https://metamask.io/) and [Chorus One ↗](https://chorus.one/).
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.

Better link to case studies in blog


import Image from '@theme/IdealImage'

# Launch Operator Service V4
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.

Suggested change
# Launch Operator Service V4
# Launch Operator Service

Comment on lines +13 to +15
:::custom-warning[V4 Only]
Fee Splitter is only available for Operator Service V4. [Upgrade →](/operator/operator-service-v3/v4-upgrade-guide)
:::
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.

Remove this

@@ -0,0 +1,75 @@
---
title: Manual Exit
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.

Manually Exit Validators

```

Run commands with:
Run commands from inside the `v3-operator` folder using this format:
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.

Suggested change
Run commands from inside the `v3-operator` folder using this format:
Run commands using this format:

@@ -1,7 +1,7 @@
---
title: Monitoring
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.

Rename to Operator Monitoring and move it after 8. Start Operator in sidebar

import Admonition from '@theme/Admonition';
import useBaseUrl from '@docusaurus/useBaseUrl';

# Smoothing Pool Relays
Copy link
Copy Markdown
Member

@tsudmi tsudmi Mar 28, 2026

Choose a reason for hiding this comment

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

Move it after Operator Monitoring in sidebar

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.

4 participants