Skip to main content

Module docs

Module docs 

Source
Expand description

Actions for dsp docs [topic].

docs is the one action with neither a DspClient (it reads embedded files, never the network) nor a Renderer: its output is raw markdown (a topic body) or a plain prose topic list, both format-agnostic, so the five-format renderer matrix does not apply and DocsArgs carries no --format flag. Output goes to an injected writer via the run / run_impl seam (the same testability pattern as auth::status). See ADR-0010.

Topics are authored as markdown under docs/topics/ and embedded at compile time with include_str! — a missing file is a compile error.

Structs§

Topic
A unit of embedded end-user documentation. See CONTEXT.md (“Topic”).

Functions§

run
Display embedded documentation: list topics, or print one topic’s body.