https://github.com/chorusone/network-handbook
Chorus One’s network handbook with node software best practices
https://github.com/chorusone/network-handbook
Last synced: 11 months ago
JSON representation
Chorus One’s network handbook with node software best practices
- Host: GitHub
- URL: https://github.com/chorusone/network-handbook
- Owner: ChorusOne
- License: other
- Created: 2024-05-01T11:38:49.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-06-27T14:28:44.000Z (12 months ago)
- Last Synced: 2025-06-27T15:37:26.271Z (12 months ago)
- Language: CSS
- Homepage: https://handbook.chorus.one/
- Size: 163 KB
- Stars: 7
- Watchers: 10
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# The Network Handbook
This repository contains the Chorus One _Network Handbook_, a book that
consolidates our learnings as a node operator about reliably operating blockchain
networks at scale. The goal of this book is to help networks take the quality of
their node software and operational procedures to the next level, to help build
stable and mature mainnets.
You can read the book at .
## Building
The book is built with [mdBook][mdBook], see the upstream documentation for more
details. To start a local preview server:
mdbook serve
The exact version of mdBook to use is listed in the `mdbook-version` file.
[mdBook]: https://rust-lang.github.io/mdBook/index.html
## Contributing
* Please put every sentence on its own line, and break long sentences across
multiple lines. This ensures that diffs are easy to review on GitHub. Try to
keep it under 80 columns if possible, but break at a logical point, don't fill
up the line. (If we would fill up the line, a small change can cause the
entire paragraph to re-flow, which pollutes the diff.)
* For listing best practices, use a level-4 heading (`####`), so that we have
an anchor to link to. Apply one of the p0–p3 classes to indicate priority
by adding `{.p0}` at the end of the heading. Use a custom anchor to ensure
that links remain stable even if we rephrase the advice. See also [heading
attributes][heading-attributes] in mdBook.
* We accept external contributions for small corrections like typo fixes.
For larger changes, please open an issue first. While we strive to write a
neutral handbook with general best practices, being somewhat opinionated is
inevitable; some editorial judgment is needed to keep the book coherent.
[heading-attributes]: https://rust-lang.github.io/mdBook/format/markdown.html#heading-attributes
## License
This book is licensed under the [Creative Commons BY-NC-SA 4.0][license] license.
[license]: https://creativecommons.org/licenses/by-nc-sa/4.0/