How the documentation is organized

This book uses four kinds of documentation:

  • Tutorials are guided paths. They assume little context and aim for a working result.
  • Topic guides explain how nacelle works and why it is shaped the way it is.
  • How-to guides are recipes for specific tasks.
  • Reference pages are precise descriptions of behavior, APIs, and protocol contracts.

Use tutorials when you are new, topic guides when you need a model of the system, how-to guides when you have a concrete job, and reference pages when you need exact details.