Module outline 

The manual’s outline: the order the reader meets the chapters in, grouped into parts, with hand-written pages (install, controls, reference, troubleshooting) among the generated ones. The sections stay as the specs have them, because their setups inherit from their parents; the outline only says where each top-level chapter goes.

outline.txt in the suite’s directory:

Part: Start here
  Page: installing          manual/installing.md
  Page: the-installer [desktop]
Part: Brewing
  Section: The kettle

A page’s title is its first # line. [desktop] limits a page to one platform. A top-level section that no part names goes into a last part, “More”.

Structs

Authored

A page written by hand, in Markdown, with [[links]] into the generated pages.

Outline

Part

Enums

Item

Functions

first_sentence

Up to the first full stop that ends a sentence.

of

The suite’s outline, with its problems on stderr.