Documentation
¶
Overview ¶
Package adr parses ADR files under docs/decisions and renders the ACTIVE.md index. Generated by awf sync (regenerates docs/decisions/ACTIVE.md).
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RenderActiveMD ¶
RenderActiveMD renders the ACTIVE.md index for dir, grouped by status. It returns a placeholder index when dir holds no ADRs (ADR-0020).
func RenderDomainIndex ¶
RenderDomainIndex renders the per-domain ADR index for the decisions directory dir: every ADR whose domains frontmatter includes domain, grouped by status in the same order as ACTIVE.md, with links relative to docs/domains/ (one dir over) and each superseded entry annotated with its successor. Returns a placeholder line when no ADR matches, so the rendered section is never empty.
Types ¶
type ADR ¶
type ADR struct {
Number string // e.g. "0001"
Title string // e.g. "ADR-0001: Template Overlay Rendering Engine"
Status string // e.g. "Accepted"
Filename string // e.g. "0001-template-overlay-rendering-engine.md"
Path string // path as globbed
Domains []string // `domains:` frontmatter (ADR-0014)
SupersededBy string // `superseded_by:` frontmatter (e.g. "0008", or "")
RetiresInvariants []string // `retires_invariants:` frontmatter (ADR-0031)
Sections map[string]string // `## ` heading -> section body
}
ADR is a parsed ADR record.