b98f46c04d
* Avoid global in p2p macro (fixes #4578) * copy p2p macro to this repo and start de-crufting it * make protocol registration dynamic, removing light client hacks et al * split out light client protocol into its own file * cleanups * Option -> Opt * remove more cruft * further split beacon_sync this allows the light client to respond to peer metadata messages without exposing the block sync protocol * better protocol init * "constant" protocol index * avoid casts * copyright * move some discovery code to discovery * avoid extraneous data copy when sending chunks * remove redundant forkdigest field * document how to connect to a specific peer |
||
|---|---|---|
| .. | ||
| src | ||
| .gitignore | ||
| CNAME | ||
| README.md | ||
| mkdocs.yml | ||
README.md
The Nimbus Guide is written using markdown and material for mkdocs.
See the Makefile for setup.
The guide is divided into several sections - broadly:
- Guides - walk-throughs that allow the user to get started with a specific area of the client
- How-to:s - short pages that show the user how to solve a specific problem or perform a specific task
- Reference - pages describing how specific parts of Nimbus work, reference-style
- "Other" - explanations of concepts, background etc.
Resources
- material for mkdocs - doc generator
- divio - useful resource diving into the above section structure