Guide

Reference

Find exact public modules and symbols after the guides have established their meaning.

Reference answers “what is the exact public surface?” The guides answer what a construct means, when to choose it, and which failure or authority boundary it preserves.

Reference names the surface

Reach for a guide when you are still deciding between State.Atomic and State.Done, Query.gen and Query.fn, an Activity and a child chart, or a typed client read and committed inspection. Reach for reference after that decision, when the remaining question is a constructor, type parameter, return channel, service requirement, or exported diagnostic.

Reference may restate signatures mechanically. It must not become a shorter, competing explanation of the language.

Follow the owning module

Generated API is the next layer

The current documentation exposes the public vocabulary through canonical guides; generated, signature-complete module pages are not published yet. Until they are, each guide links the exact symbols it teaches and the Playground typechecks complete programs against the workspace's public surface.

This page is the stable boundary for that future generated index. Generation should project the actual package exports and doc comments rather than hand-maintaining a second inventory that can drift from source.