Skip to content

docs: restructure validator operator docs based on feedback#311

Merged
emmajam merged 55 commits intomainfrom
centaur/operator-docs-feedback
Apr 22, 2026
Merged

docs: restructure validator operator docs based on feedback#311
emmajam merged 55 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 22, 2026 11:09am

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>
Paradigm AI and others added 2 commits April 20, 2026 05:36
1. Generate signing keypair
2. Create add-validator signature
3. Submit registration details to Tempo team

Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019da962-06e0-7083-806a-3d46ee63e7b1
Paradigm AI and others added 2 commits April 20, 2026 06:25
- Rename page and file from validator-state to validator-status
- Update 'Look up your validator' to use tempo consensus validator <pubkey>
- Add example JSON output based on IValidatorConfig::Validator struct
- Link pubkey param to initial setup and managing keys pages
- Update all cross-references across docs

Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019da962-06e0-7083-806a-3d46ee63e7b1
…atorEntry structs

Example JSON now matches the actual serde output from tempo_cmd.rs:
- Top-level: current_epoch, current_height, last_boundary, epoch_length,
  is_next_full_dkg, next_full_dkg_epoch
- Per-validator: onchain_address, public_key, inbound_address,
  outbound_address, active, is_player, is_dealer

Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019da962-06e0-7083-806a-3d46ee63e7b1
Paradigm AI and others added 2 commits April 20, 2026 06:39
…or struct

Fields now match the on-chain Validator struct from validator_config.rs:
publicKey, active, index, validatorAddress, inboundAddress, outboundAddress

Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019da962-06e0-7083-806a-3d46ee63e7b1
…m 786c8ce

Sourced from tempo_cmd.rs at commit 786c8ce. SingleValidatorOutput flattens
ValidatorEntry fields (onchain_address, public_key, inbound_address,
outbound_address, fee_recipient, index, active, is_dkg_dealer,
is_dkg_player, in_committee) alongside current_epoch and current_height.

Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019da962-06e0-7083-806a-3d46ee63e7b1
Comment thread src/pages/guide/node/validator-monitoring.mdx Outdated
Comment thread src/pages/guide/node/validator-monitoring.mdx Outdated
Comment thread vocs.config.ts
Comment thread src/pages/guide/node/validator-troubleshooting.mdx Outdated
Comment thread src/pages/guide/node/validator-troubleshooting.mdx
Comment thread src/pages/guide/node/validator-troubleshooting.mdx Outdated
Comment thread src/pages/guide/node/validator-setup.mdx Outdated
Comment thread src/pages/guide/node/validator-setup.mdx Outdated
Comment thread vocs.config.ts Outdated
@emmajam emmajam merged commit 9f6dcf5 into main Apr 22, 2026
10 of 14 checks passed
@emmajam emmajam deleted the centaur/operator-docs-feedback branch April 22, 2026 11:16
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