Skip to main content

Crate rto_render

Crate rto_render 

Source
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.
ConfigSecretSummary
The _Home overview’s config-secret inventory figures.
CouplingEntry
One node in the _Home overview’s directed-coupling table.
DensityEntry
One file in the _Home overview’s intent-debt density table.
IndexEntry
An entry in the ADR/docs index page.
RenderedAdr
A rendered ADR: its title (for the index) and the full themed HTML page.
VaultNote
A rendered vault note: its filename (with .md) and markdown content.
VaultSummary
Aggregate figures for the vault’s _Home overview 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 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.
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 Rust use can 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, 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_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 Explanation into an Obsidian note: YAML frontmatter (with tags for the graph view and an ADR’s status), a clickable Source link (when source_base — a web “blob” base like https://github.com/org/repo/blob/<sha> — is known and the node has a path), the captured content as the knowledge base, and its edges as provenance- labelled wikilinks.