Skip to main content

Crate rto_render

Crate rto_render 

Source
Expand description

Renderers over the Roteiro graph. All outputs — docs site, OKF bundle, and the optional MCP server (feature mcp) — are build products of the same store, so humans and agents always see the same data.

Modules§

okf
The OKF bundle renderer (#663) — the open-format successor to the vault. Render the graph as an Open Knowledge Format bundle (issue #663).
tool_class
The one place a tool’s class is written, and the report that stands in for a class an operator did not load (#664). The one place a tool’s class is written, and the report that stands in for a class an operator did not load.
tool_text
The one place each shared tool description is written (#590). The one place each shared tool description is written.

Structs§

IndexEntry
An entry in the ADR/docs index page.
NavEntry
One page in the site navigation bar: where it goes and what it is called.
PublishedPages
Where each source document is actually published: the file the site serves, keyed by the source markdown’s file name.
RenderedAdr
A rendered ADR: its title (for the index) and the full themed HTML page.
SourceBase
Where a link that leaves the site points instead: the repository’s own web view, at the commit the site was built from.

Enums§

Target
A render target for the graph.

Functions§

markdown_to_html
Convert CommonMark md to an HTML fragment (GitHub tables + strikethrough, and Roteiro [[wiki-links]] resolved). Resolves ADR links relative to the ADR directory; use render_doc for root-level pages.
render_adr
Render one ADR markdown document to a themed HTML page. Leading YAML frontmatter is stripped; the title is the first # heading, or fallback if there is none. ADR [[…]] links resolve to sibling ADR pages.
render_adr_index
Render the docs index: any lifetime docs (Build Plan, …) then the ADRs.
render_doc
Render a root-level “lifetime doc” (e.g. the Build Plan) to a themed page. Its [[docs/adr/…]] links resolve into the adr/ subdirectory.
render_nav
The site navigation bar: one link per page, the current one marked.
render_site_page
Render one site page — a document that declared itself published — to a themed root-level page carrying the site navigation bar.
replace_site_nav
Replace the <nav class="sitenav">…</nav> block in a hand-written page with the bar the renderer computes, returning None when the page carries no such block.