Skip to content

docs: restructure validator operator docs based on feedback#311

Draft
gakonst wants to merge 6 commits intomainfrom
centaur/operator-docs-feedback
Draft

docs: restructure validator operator docs based on feedback#311
gakonst wants to merge 6 commits intomainfrom
centaur/operator-docs-feedback

Conversation

@gakonst
Copy link
Copy Markdown
Contributor

@gakonst gakonst commented Apr 16, 2026

Addresses feedback from Slack thread on operator docs. Changes:

  • Restructured operate-validator.mdx into clear actionable sections: validator states, checking state, lifecycle, managing keys, monitoring, log management
  • Moved warnings to the top of their respective sections (data reset danger, key rotation warnings)
  • Added testnet/mainnet code tabs for all --rpc-url commands and node startup commands — no more hardcoded RPC URLs
  • Added "even with the Tempo team" phrasing to encourage reaching out for support
  • Updated key hierarchy to reference v2 rotation flow (preserves validator index) instead of old remove-and-recreate language
  • Fixed "see below" references to be proper links to actual sections
  • Shrunk validator states diagram via maxWidth constraint
  • Grouped code blocks into ::::code-group for cleaner presentation

cc @U095KMJDYHJ @U09FB041BV4

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 16, 2026

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

Project Deployment Actions Updated (UTC)
tempo-docs Ready Ready Preview, Comment Apr 17, 2026 1:32pm

Request Review

Replaces 'Operation' and 'ValidatorConfig V2' with four focused pages:
- Checking validator state (states diagram, metrics, on-chain queries)
- Controlling validator lifecycle (start/stop, registration, rotation, deactivation)
- Managing validator keys (key hierarchy, generation, rotation, share recovery)
- Observing a validator (monitoring, metrics glossary, Grafana, logs)

All cross-references updated. Mainnet/testnet code tabs added to all RPC commands.

Amp-Thread-ID: https://ampcode.com/threads/T-019d9aa2-72ab-7528-b44d-d82c81cc98ef
Co-authored-by: Amp <amp@ampcode.com>
- Overview now just links to all sub-pages with short descriptions
- 'Deploying a validator' converted to info box
- Removed duplicate key hierarchy section
- 'Generating a signing key' + 'Running the validator' moved to 'Initial setup'
- 'Troubleshooting' moved to 'Troubleshooting and FAQ'

Amp-Thread-ID: https://ampcode.com/threads/T-019d9aa2-72ab-7528-b44d-d82c81cc98ef
Co-authored-by: Amp <amp@ampcode.com>
Paradigm AI and others added 2 commits April 17, 2026 13:24
- Moved registration values table and add-validator signature from
  validator-lifecycle to validator-setup
- Updated overview info box to link to initial setup instead of lifecycle
- Updated overview description

Amp-Thread-ID: https://ampcode.com/threads/T-019d9aa2-72ab-7528-b44d-d82c81cc98ef
Co-authored-by: Amp <amp@ampcode.com>
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