Skip to main content

Module reference_docs

Module reference_docs 

Source
Expand description

Generated reference documentation.

Renders Markdown appendices directly from the in-code single sources of truth (the MCP tool registry and the Config schema) so the published reference can never drift from the actual feature surface.

  • mcp-tools.md — every registered MCP tool, from manifest_value().
  • config-keys.md — every recognized config.toml key, from ConfigSchema.

Used by the gen_docs example (writes the files) and by drift tests / the CI gate (compare on-disk vs. freshly rendered).

Functions§

config_keys_markdown
Markdown reference for every recognized config.toml key, rendered from the Config schema (types, defaults, allowed values, env overrides).
content_matches
True when on-disk content equals freshly generated content, ignoring line-ending differences. Windows checkouts may store the committed docs with CRLF while the generator emits LF; the drift gate compares content, not byte-exact line endings.
generated_dir
Directory the generated reference docs live in (docs/reference/generated).
generated_docs
Every generated reference document as (filename, markdown) pairs. This is the canonical list shared by the writer and the drift tests.
mcp_tools_markdown
Markdown reference for every registered MCP tool (granular profile), rendered from the same manifest the editors consume.