Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

(Improvement) Add Pruning Strategy Configuration Guide to Validator Node Documentation

Aperta
#996 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

Inizia da docs/node/run-your-node/prerequisites/hardware-recommendations.md e dalla sezione Configuration di docs/node/run-your-node/validator-node.mdx. Verifica come sono definiti i parametri di pruning e le strategie disponibili prima di documentare dove devono essere inserite le impostazioni consensus.prune e runtime.prune. Il lavoro è completato quando la documentazione del validator node spiega chiaramente la posizione della configurazione e le opzioni keep_n e default.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Description:
In the current documentation, the hardware recommendations mention pruning strategies for the consensus and ParaTime states, but there's no detailed guide on how to configure these pruning strategies.

References:

  • In hardware-recommendations.md, it states:

    "To enable pruning of the consensus state, set the consensus.prune.strategy and consensus.prune.num_kept parameters appropriately in your node's configuration.
    To enable pruning of the ParaTime state, set the runtime.prune.strategy and runtime.prune.num_kept parameters appropriately in your node's configuration."

  • However, the pruning strategies themselves are not explained in this section, and there is no clear guidance on where to place these parameters within the node's configuration file.

Suggestion:
I would like to recommend the following improvements to the documentation:

  1. Add a new section dedicated to Configuration, which can explain pruning strategies and other common settings. This section could provide clarity on where to define consensus.prune.strategy and runtime.prune.strategy, and what options are available (e.g., keep_n, default).

  2. If adding a new section is not ideal, consider including a small guide in the Validator Node configuration chapter (linked here) that explains pruning strategies in detail. This could also help users understand the correct placement of these parameters.

Lingua principale
TypeScript
Stelle
15
Fork
46
Merge medio
1g 21h
PR unite (30g)
1

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di oasisprotocol/docs

Tutte le issue di oasisprotocol/docs

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.