Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

p2p: review and update the documentation of the p2p configuration parameters #1038

Open
7 tasks
Tracked by #19
cason opened this issue Jun 27, 2023 · 1 comment
Open
7 tasks
Tracked by #19

Comments

@cason
Copy link
Contributor

cason commented Jun 27, 2023

The following content needs to be updated accordingly with the implementation:

  • Description of the configuration parameters for the configuration file: config/toml.go
  • Documentation of configuration parameters on Go source code: config/config.go
  • Documentation of configuration parameters, currently in spec/p2p/legacy-docs/config.md, potentially to be moved (back, once updated) to spec/p2p/config.md (intersects with spec/p2p: review, update, and consolidate the legacy documentation #981 )
  • Documentation of configuration parameters under docs/ (e.g. docs/core/running-in-production.md, docs/core/validators.md)
  • Verify and validate the differences on all this content between main and release branches

As a stretch goal:

  • Reduce the degree of redundancy on the documentation
  • Render the backporting process simpler by highlighting parts of the documentation and configuration flags that are specific for a given version
@cason
Copy link
Contributor Author

cason commented Feb 21, 2024

@greg-szabo, are you considering this as part of #2351?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Todo
Development

No branches or pull requests

1 participant