Skip to content

Commit d5812d3

Browse files
committed
refactor: restructure validator section into broader nodes category
1 parent 3925b81 commit d5812d3

File tree

14 files changed

+57
-6189
lines changed

14 files changed

+57
-6189
lines changed

.vitepress/theme.config.ts

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -187,22 +187,32 @@ export const themeConfig = {
187187
sidebar: nimiqUtilsSidebar,
188188
},
189189
{
190-
text: 'Validators',
191-
subpath: 'validators',
190+
text: 'Nodes',
191+
subpath: 'nodes',
192192
icon: 'i-local:nimiq-validators',
193-
defaultPageLink: '/validators/',
194-
description: 'Staking and pools',
193+
defaultPageLink: '/nodes/',
194+
description: 'Nimiq Nodes',
195195
sidebar: [
196+
{
197+
items: [
198+
{ text: 'Overview', link: '/nodes/', icon: 'i-tabler:layout-grid' },
199+
],
200+
},
196201
{
197202
label: 'Validators',
198203
items: [
199-
{ text: 'Overview', link: '/validators/', icon: 'i-tabler:layout-grid' },
200-
{ text: 'Becoming a Validator', link: '/validators/becoming-a-validator', icon: 'i-tabler:user-check' },
201-
{ text: 'Prover Node Setup Guide', link: '/validators/prover-node-guide', icon: 'i-tabler:server' },
202-
{ text: 'Staking Handbook', link: '/validators/staking-handbook', icon: 'i-tabler:book' },
203-
{ text: 'Validator Trustscore', link: '/validators/validator-trustscore', icon: 'i-tabler:shield-star' },
204-
{ text: 'FAQs for Stakers and Pools', link: '/validators/staking-faq', icon: 'i-tabler:help' },
205-
{ text: 'Add Your Pool to the Wallet', link: 'https://github.com/nimiq/validators-api?tab=readme-ov-file#nimiq-validators', icon: 'i-tabler:wallet' },
204+
{ text: 'Becoming a Validator', link: '/nodes/validators/becoming-a-validator', icon: 'i-tabler:user-check' },
205+
{ text: 'Staking Handbook', link: '/nodes/validators/staking-handbook', icon: 'i-tabler:book' },
206+
{ text: 'Validator Trustscore', link: '/nodes/validators/validator-trustscore', icon: 'i-tabler:shield-star' },
207+
{ text: 'FAQs for Stakers and Pools', link: '/nodes/validators/staking-faq', icon: 'i-tabler:help' },
208+
{ text: 'Add Your Pool to the Wallet', link: 'https://github.com/nimiq/validators-api#add-your-validator-information', icon: 'i-tabler:wallet' },
209+
],
210+
},
211+
{
212+
label: 'Nodes',
213+
items: [
214+
{ text: 'Node Setup', link: 'https://github.com/nimiq/core-rs-albatross?tab=readme-ov-file#configuration', icon: 'i-tabler:lock' },
215+
{ text: 'Prover Node Setup Guide', link: '/nodes/prover-node-guide', icon: 'i-tabler:server' },
206216
],
207217
},
208218
],

.vitepress/theme/components/YellowPages.vue

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ const sections = [
3434
{
3535
title: 'Validators & Staking',
3636
links: [
37-
{ title: 'Become Validator', href: '/validators/becoming-a-validator' },
38-
{ title: 'Prover Node Setup', href: '/validators/prover-node-guide' },
39-
{ title: 'Staking Handbook', href: '/validators/staking-handbook' },
40-
{ title: 'Validator Trustscore', href: '/validators/validator-trustscore' },
41-
{ title: 'Staking FAQ', href: '/validators/staking-faq' },
37+
{ title: 'Become Validator', href: '/nodes/validators/becoming-a-validator' },
38+
{ title: 'Prover Node Setup', href: '/nodes/prover-node-guide' },
39+
{ title: 'Staking Handbook', href: '/nodes/validators/staking-handbook' },
40+
{ title: 'Validator Trustscore', href: '/nodes/validators/validator-trustscore' },
41+
{ title: 'Staking FAQ', href: '/nodes/validators/staking-faq' },
4242
],
4343
},
4444
]

index.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ hero:
2323
- icon: i-local:nimiq-validators
2424
title: Validators
2525
description: Secure the network and earn rewards
26-
href: ./validators/
26+
href: ./nodes/validators/becoming-a-validator
2727
hoverColor: green
2828
- icon: i-local:nimiq-albatross
2929
title: Albatross
@@ -79,6 +79,7 @@ hoverableGrid:
7979
- title: RPC Quick Start
8080
description: Explore docs and run JSON-RPC from your environment
8181
href: ./rpc-client/
82+
icon: i-local:nimiq-rpc
8283
- title: Nimiq MCP
8384
description: Build with AI
8485
href: https://github.com/onmax/nimiq-mcp
@@ -119,12 +120,12 @@ popularResources:
119120
href: https://github.com/onmax/nimiq-identicons
120121
- title: Backend & API
121122
links:
122-
- text: RPC Playground
123-
href: ./rpc-client/playground
124123
- text: RPC Methods
125124
href: ./rpc-client/methods/
126-
- text: Client Libraries
127-
href: ./rpc-client/clients
125+
- text: TypeScript
126+
href: ./rpc-client/integrations/typescript
127+
- text: ARPL CLI Tool
128+
href: https://github.com/sisou/arpl
128129
- text: Account Queries
129130
href: ./rpc-client/methods/get-accounts
130131
- text: Send Transactions
@@ -142,23 +143,23 @@ popularResources:
142143
- title: Node Operators
143144
links:
144145
- text: Prover Node Guide
145-
href: ./validators/prover-node-guide
146+
href: ./nodes/prover-node-guide
146147
- title: Validator Operators
147148
links:
148149
- text: Becoming a Validator
149-
href: ./validators/becoming-a-validator
150+
href: ./nodes/validators/becoming-a-validator
150151
- text: Staking Handbook
151-
href: ./validators/staking-handbook
152+
href: ./nodes/validators/staking-handbook
152153
- text: Trustscore System
153-
href: ./validators/validator-trustscore
154+
href: ./nodes/validators/validator-trustscore
154155
- text: Staking FAQ
155-
href: ./validators/staking-faq
156+
href: ./nodes/validators/staking-faq
156157
- text: Validators API
157-
href: https://github.com/nimiq/validators-api
158+
href: https://github.com/nimiq/validators-api#add-your-validator-information
158159
- text: Validator RPC Docs
159-
href: ./validators/rpc-docs/
160+
href: ./rpc-client
160161
- text: ARPL CLI Tool
161-
href: https://github.com/sisou/arpl
162+
href: https://github.com/sisou/arpl?tab=readme-ov-file#sisoualbatross-remote-arpl
162163
- title: Core & Protocol
163164
links:
164165
- text: Protocol Docs
Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,43 +5,28 @@ links:
55
label: Connect
66
icon: i-nimiq:verified
77
description: Collect stake, validate blocks and earn.
8-
href: becoming-a-validator
8+
href: ./validators/becoming-a-validator
99
- label: RPC
1010
title: Connect via RPC
1111
bgColor: blue
1212
icon: i-tabler:plug
13-
href: /rpc-client/
13+
href: ../rpc-client/
1414
docs:
1515
- title: Becoming a Validator
16-
href: /validators/becoming-a-validator
16+
href: ./validators/becoming-a-validator
1717
icon: i-tabler:user-check
1818
iconClass: 'absolute top-12 right-12 size-24 text-neutral-700 dark:text-neutral-300'
1919
description: 'Requirements and step‑by‑step guide to run a validator node.'
2020
- title: Prover Node Setup
21-
href: /validators/prover-node-guide
21+
href: ./prover-node-guide
2222
icon: i-tabler:server
2323
iconClass: 'absolute top-12 right-12 size-24 text-neutral-700 dark:text-neutral-300'
2424
description: 'How to run a prover node used by the network’s ZKP system.'
25-
- title: Staking Handbook
26-
href: /validators/staking-handbook
27-
icon: i-tabler:book
28-
iconClass: 'absolute top-12 right-12 size-24 text-neutral-700 dark:text-neutral-300'
29-
description: 'Concepts, operations, and best practices for staking in Nimiq.'
30-
- title: Validator Trustscore
31-
href: /validators/validator-trustscore
25+
- title: Node Setup
26+
href: https://github.com/nimiq/core-rs-albatross?tab=readme-ov-file#configuration
3227
icon: i-tabler:shield-star
3328
iconClass: 'absolute top-12 right-12 size-24 text-neutral-700 dark:text-neutral-300'
34-
description: 'How trustscore works and what affects validator reputation.'
35-
- title: Staking FAQs
36-
href: /validators/staking-faq
37-
icon: i-tabler:help
38-
iconClass: 'absolute top-12 right-12 size-24 text-neutral-700 dark:text-neutral-300'
39-
description: 'Answers to common questions from stakers and pool operators.'
40-
- title: Add Your Pool to the Wallet
41-
href: https://github.com/nimiq/validators-api?tab=readme-ov-file#nimiq-validators
42-
icon: i-tabler:wallet
43-
iconClass: 'absolute top-12 right-12 size-24 text-neutral-700 dark:text-neutral-300'
44-
description: 'Instructions to list your pool in the Nimiq Wallet.'
29+
description: 'Concepts, operations, and best practices for staking in Nimiq.'
4530
prose: false
4631
prev: false
4732
next: false
File renamed without changes.
File renamed without changes.
File renamed without changes.

rpc-client/open-servers.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,23 +67,25 @@ Public Nimiq RPC servers available for testing, development, and prototyping.
6767
label="Community"
6868
headline="Share Your Node with the Community"
6969
subline="Set up your own Nimiq node and consider making it available as an open RPC server to help other developers in the ecosystem."
70-
linkHref="/validators/becoming-a-validator"
70+
linkHref="../nodes/validators/becoming-a-validator"
7171
linkLabel="Setup Guide"
7272
/>
7373

7474
## General considerations for open servers
7575

7676
### Production usage
77+
7778
- Not suitable for production applications.
7879
- No uptime guarantees or service level agreements.
7980
- May experience throttling during peak usage.
8081
- Method availability may change without notice.
8182

8283
### Data privacy
84+
8385
- All requests _may_ be logged for monitoring purposes.
8486
- Do not send sensitive information through open servers.
8587
- Consider IP addresses and request data as potentially visible to operators.
8688

8789
---
8890

89-
*Open servers are community-provided resources. Always verify data independently for critical applications.*
91+
_Open servers are community-provided resources. Always verify data independently for critical applications._

0 commit comments

Comments
 (0)