docs(config): Configuration reference manual (backport #2352)#2758
Merged
docs(config): Configuration reference manual (backport #2352)#2758
Conversation
Closes #2351. --- This PR is the configuration reference manual. This is the first page of the manual, where you can click through to all the config pages: https://staging-cometbft-docs.netlify.app/staging/references/config/ Sections to review: - [x] genesis.json + priv_validator_key.json -> @adizere @andynog - [x] node_key.json + priv_validator_state.json - [x] main page + config.toml Base configuration section @andynog - [x] config.toml RPC server + gRPC server sections @andynog - [x] config.toml Peer-to-peer section @cason - [x] config.toml Mempool section @andynog @sergio-mena - [x] config.toml State synchronization + Block synchronization sections @andynog @sergio-mena - [x] config.toml Consensus section @cason - [x] config.toml Storage @andynog @sergio-mena - [X] config.toml Transaction Indexer, and Prometheus Instrumentation sections -> @adizere - [x] Add compaction documentation @andynog #### PR checklist - ~~[ ] Tests written/updated~~ - ~~[ ] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [X] Updated relevant documentation (`docs/` or `spec/`) and code comments - [X] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com> Co-authored-by: Andy Nogueira <me@andynogueira.dev> Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Hernán Vanzetto <15466498+hvanz@users.noreply.github.com> Co-authored-by: Jacob Gadikian <jacobgadikian@gmail.com> Co-authored-by: Adi Seredinschi <a@seredinschi.net> Co-authored-by: Adi Seredinschi <adizere@gmail.com> Co-authored-by: Daniel <daniel.cason@informal.systems> Co-authored-by: Dante Sanchez <dante.a.sanchez@gmail.com> Co-authored-by: Anca Zamfir <ancazamfir@users.noreply.github.com> Co-authored-by: Sergio Mena <sergio@informal.systems> (cherry picked from commit 56d5474)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #2351.
This PR is the configuration reference manual.
This is the first page of the manual, where you can click through to all the config pages: https://staging-cometbft-docs.netlify.app/staging/references/config/
Sections to review:
PR checklist
[ ] Tests written/updated[ ] Changelog entry added in.changelog(we use unclog to manage our changelog)docs/orspec/) and code commentsThis is an automatic backport of pull request #2352 done by [Mergify](https://mergify.com).