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.
- Config
Secret Summary - The
_Homeoverview’s config-secret inventory figures. - Coupling
Entry - One node in the
_Homeoverview’s directed-coupling table. - Cross
Link - One cross-repo edge the workspace vault can actually follow: a spoke’s node linking to a hub’s, through the external-ref placeholder ADR-0009 persists.
- Density
Entry - One file in the
_Homeoverview’s intent-debt density table. - 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.
- Vault
Note - A rendered vault note: its filename (with
.md) and markdown content. - Vault
Scope - Which vault a note is being rendered into: a single project’s, or one member of a workspace vault spanning several repositories.
- Vault
Summary - Aggregate figures for the vault’s
_Homeoverview note. - Workspace
Summary - Aggregate figures for a workspace vault’s
_Homeoverview: the members, each with exactly the aggregates a single-project_Homecarries, plus the cross-repo links between them.
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 that is unique per key even after case folding.
- 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_
nav - The site navigation bar: one link per page, the current one marked.
- render_
note - Render a node’s
Explanationinto an Obsidian note: YAML frontmatter (withtagsfor the graph view and an ADR’sstatus), a clickable Source link (whensource_base— a web “blob” base likehttps://github.com/org/repo/blob/<sha>— is known and the node has a path), the content as the knowledge base, and its edges as provenance-labelled wikilinks. - render_
note_ scoped render_note, for one member of a workspace vault: identical except that the note’s own name and every link it emits are resolved throughscope(seeVaultScope).- render_
site_ page - Render one site page — a document that declared itself published — to a themed root-level page carrying the site navigation bar.
- render_
workspace_ home - Render a workspace vault’s overview: the members and their scale, the cross-repo links between them, and then each member’s own aggregates — structure, provenance, ADRs, intent debt, config-secret inventory and call coupling — under its own heading.
- 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. - scoped_
note_ name - The note name for a node
keyowned byscope’s project.