Module docs 

Documentation pages embedded in the binary and served to agents as MCP resources (featherbit://docs/...). The docs site’s Markdown is the single source of truth for plugin config keys, so agents read the same pages humans do — minus Docusaurus frontmatter and JSX.

Structs

DocPage

A listable page. Only constructed by list_pages, which is mcp-only.

DocsAssets 🔒

website/docs/ subset compiled into the binary (~300 KB).

Enums

DocSection

Which docs directory a page lives in.

Constants

DOCS_URI_PREFIX

URI prefix of every documentation resource.

Functions

clean

Strips frontmatter (keeping the title as an H1), import lines, and JSX elements (single-line <span …>…</span> and multi-line <Component … /> blocks), and rewrites relative .md links to featherbit://docs/… URIs. Fenced code blocks (opened/closed by a line whose trimmed form starts with ```) pass through verbatim — no import/JSX/link processing — since example bodies routinely contain <Uppercase...> tokens (e.g. an RFC 5424 <PRI>... syslog frame) that would otherwise be mistaken for an unterminated JSX block, silently swallowing everything after it for the rest of the page.

concept_page

A concepts page by file stem (e.g. supernodes).

frontmatter 🔒

Frontmatter title/description (both may be empty).

guide_page

A how-to guide (lua-scripting, debugging, routing, …). Only reached via read_uri.

link_re 🔒

list_pages

Every page, for resources/list. Only used by the MCP resources/list handler in src/mcp/server.rs.

page 🔒

plugin_file 🔒

The file behind a node type’s page (listener/client share one).

plugin_page

The cleaned page for a node type.

raw 🔒

read_uri

Resolves a featherbit://docs/{section}/{name} URI. Only used by the MCP resources/read handler in src/mcp/server.rs.

reference_page

A reference page by file stem (context-vars, conditions, templates). Only reached via read_uri, which is mcp-only (the Admin API’s render_prompt calls plugin_page/concept_page directly).