Prelude

What's the goal of this handbook?

To slowly start building this up:

• Critical docs: Concepts, Guides and References.
  • Concepts: The internal technical detail, research and relevant topics.
  • Guides: A guide on how the features can be used from a user perspective.
    • User: How to interact and use the node as a regular user.
    • Developer: How to interact on a deeper perspective as a developer.
    • Institution: How to interact with the node for exchanges, dealing with updates, best practices etc.
  • References: A to-the-point reference that's used for quick references.
• Standard practices for coding, git, things like how to add a new data structure, add rpc, etc
• Testing: how to write a test and contribute (so we can welcome external contributions too), and release checks
• Links to pink paper, external resources of all kind (a dedicated page similar to github awesome-{x} repos.
• Anything that's doesn't belong in the source code or is process related.

How do I read and write this handbook?

The book uses the simplest Markdown generator available, mdbook - intentionally. No big features. It's simple. Any engineer should be able to learn and use it in minutes - not hours.

• Reading the handbook
• Contributing to the handbook

Learn about it here: mdbook

Attributions

Parts of this handbook were edited from the Bitcoin Wiki.