Skip to main content

Module docs

Module docs 

Source
Expand description

Implementation of the zad docs [topic] subcommand mandated by OSS_SPEC.md §12.3.

Every topic doc under docs/*.md is embedded into the binary via include_str! so the exact text a contributor ships is the exact text an agent sees at runtime — no filesystem lookups, no version skew between the installed binary and the source tree.

Paths resolve through the crates/zad-cli/docs symlink, which points at ../../docs (the canonical docs tree at the repo root). The symlink is resolved when cargo packages the crate, so the published tarball ships the doc files as real entries and the cargo publish verify step can compile the package outside the workspace. Don’t replace the symlink with copies — that would immediately drift from the canonical docs.

Structs§

DocsArgs

Functions§

run