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§
- Index
Entry - An entry in the ADR/docs index page.
- NavEntry
- One page in the site navigation bar: where it goes and what it is called.
- Published
Pages - Where each source document is actually published: the file the site serves, keyed by the source markdown’s file name.
- Rendered
Adr - A rendered ADR: its title (for the index) and the full themed HTML page.
- Source
Base - 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
CommonMarkmdto an HTML fragment (GitHub tables + strikethrough, and Roteiro[[wiki-links]]resolved). Resolves ADR links relative to the ADR directory; userender_docfor 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, orfallbackif there is none. ADR[[…]]links resolve to sibling ADR pages. - render_
adr_ index - Render the docs index: any
lifetimedocs (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 theadr/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, returningNonewhen the page carries no such block.