Part 03 · Reference

What is exactly true

The specification, the workspace crate by crate, and the tables generated from the code.

Part opener · for implementers and integrators looking something up

Reference pages state what is true and nothing else. They do not teach and they do not persuade. Where a table can be produced from the code, it is, and a check in continuous integration fails when the page and the code disagree.

The part has four layers. The specification is the normative text: the Pulse, the PulseEnvelope, the ring, the store, the UDP transport, conformance, and what changes require a draft revision; the vectors under pulse/pulse-spec/test-vectors are its executable form. The workspace pages describe each tier and each crate, following the tree’s own structure. The API pages describe the surfaces other languages see. The generated pages are produced from the code by the gate.

• The specification: seven chapters here and an appendix; chapter 7, the port protocol, is in the daemon’s book, since the daemon speaks it.
• Workspace: Layout, pulse/, core/. The daemon’s tier and the rings have their pages in the daemon’s book and the profiles’ book.
• Generated from the code: the crate index and the error catalogue; the gate regenerates them and fails on any difference.
• API: Overview, Python, Node, C, and the language bindings by kind.
• Glossary.