How the Documentation is organized

Documentation is organized into four categories: tutorials, overviews, API references and how-to guides.

• Tutorials take you by the hand through a series of steps to put a library / module to use. Start here if you’re new to a library.
• Overviews discuss key topics and concepts at a fairly high level and provide useful background information and explanation. Those are the things you usually see in READMEs of repos.
• API references contain technical reference for APIs and other aspects of a module's machinery. They describe how it works and how to use it but assume that you have a basic understanding of key concepts. These are auto-generated from the code, and depend heavily on the programmer's verbosity and the technical writer's persistence.
• How-to guides are recipes. They guide you through the steps involved in addressing key problems and use-cases. They are more advanced, shorter, and more specific than tutorials and assume some previous knowledge.

Get Started

Use the search field in the header, or find a desired library in the sections below. Each library has its own documentation with a full API reference and guides. If you'd like to contribute to these docs with your own work or some corrections, please file issues or PRs in the Github repo (opens new window).

Chroniclesloggingstable

Chronicles is a library for structured logging. It adheres to the philosophy that log files shouldn't be based on formatted text strings, but rather on well-defined event records with arbitrary properties that are easy to read for both humans and machines.

Ethethkeysbloomrlpencodingformattingcryptographydevelopment

Ethereum-related utilities written in Nim. Includes things like Bloom filters, private/public key utilities, devp2p, RLP, and more.

Stewencodingformattingdevelopmentutilities

General-purpose utilities and standard library extensions