oasisprotocol / oasisprotocol/docs
(Improvement) Add Pruning Strategy Configuration Guide to Validator Node Documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 15
- Forks
- 46
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 1
Description
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.strategyandconsensus.prune.num_keptparameters appropriately in your node's configuration.
To enable pruning of the ParaTime state, set theruntime.prune.strategyandruntime.prune.num_keptparameters 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:
-
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.strategyandruntime.prune.strategy, and what options are available (e.g.,keep_n,default). -
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/node/run-your-node/prerequisites/hardware-recommendations.md and the Configuration section of docs/node/run-your-node/validator-node.mdx. Check how pruning parameters and available strategies are defined before documenting where consensus.prune and runtime.prune settings belong. Done means the validator node documentation explains the configuration placement and the keep_n and default options clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100