Expand description
Renderers over the Roteiro graph. All outputs — docs site, Obsidian vault,
and the optional MCP server (feature mcp) — are build products of the
same store, so humans and agents always see the same data.
Structs§
- AdrEntry
- One ADR in the overview, with its lifecycle status.
- Index
Entry - An entry in the ADR/docs index page.
- Rendered
Adr - A rendered ADR: its title (for the index) and the full themed HTML page.
- Vault
Note - A rendered vault note: its filename (with
.md) and markdown content. - Vault
Summary - Aggregate figures for the vault’s
_Homeoverview note.
Enums§
- Target
- A render target for the graph.
Constants§
- HOME_
NOTE - Filename of the generated overview note (sorts first in the file list).
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. - note_
name - Map a node key to a filesystem- and wikilink-safe note stem. Characters that
are awkward in filenames or Obsidian links (
:/#whitespace) collapse to-; alphanumerics,.,_and-are kept. The result is bounded in length (a grouped Rustusecan key a 300+ char import node) by truncating and appending a short hash of the full key, so notes stay under filesystem limits while remaining unique and deterministic. - 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_
home - Render the vault’s overview note: what was scanned, the structure by kind, the provenance breakdown, the decisions (ADRs) and their status, the intent-debt summary, and how to navigate. The entry point for the vault.
- render_
note - Render a node’s
Explanationinto an Obsidian note: YAML frontmatter (withtagsfor the graph view and an ADR’sstatus), the captured content as the knowledge base, and its edges as provenance-labelled wikilinks.