Skip to content

Components

Plans are more than prose. They contain decisions, code changes, schemas, and risks, and each of those deserves purpose-built review UI instead of another wall of text. Components are flow-level elements from a closed, built-in registry, rendered entirely server-side so documents stay self-contained and readable without JavaScript.

The registry never evaluates code from a plan. A component’s attributes are strings or bare booleans, structured data arrives as fenced or scoped children, and any authoring mistake fails the render with a positional diagnostic; see Authoring plans for the contract.

Component What it is for
Callout Surface a note, tip, warning, or danger so reviewers cannot miss it.
CodeDiff Review one file’s unified diff with gutters and line-anchored annotations.
CodeSnippet Inspect existing code with optional file identity, file-absolute line numbers, and annotations.
DataTable Query a dataset in place: sortable columns, optional search, selectable columns, grouping, and text fit.
DatabaseTableSchema Review one table’s DBML-subset schema and titled verbatim DDL.
Decision Review one tradeoff option by option, each carrying its own verdict-lined considerations.
DecisionAnalysis Audit or choose a weighty decision in a keyed qualitative or weighted scoring matrix.
FileTree Show a plain file hierarchy with optional per-entry notes.
FileTreeDiff Review per-entry change status as one combined change tree.
FlowDiagram Diagram a flow, dependency, or fan-out as staged cards joined by verb-labeled, directed connectors.
MermaidDiagram Review a compile-time Mermaid diagram with static light/dark SVG and stable semantic review anchors.
GraphqlOperation Review one GraphQL query, mutation, or subscription with one-level input and payload shapes and executable examples.
GrpcMethod Review one gRPC method headed by its proto signature, with message fields, status codes, and grouped examples.
HttpEndpoint Review one HTTP endpoint’s contract: parameters, request body, and status-coded responses.
Part Divide the plan’s sections into numbered acts rendered as anchored divider bands.
QuickSummary Open the plan with its few key points as a standout card, capped at five bullets and six hundred characters.
QuickDecision Answer one small brief-format question; repeat the component to batch independent calls.
Slide Apply a recurring slide type and its guidance while keeping its heading as the plan-specific title.
TableOfContents Show the plan in one look: one linked row per section with its one-line gist.
Wireframe Draw true-size product screens and connect them into a short walkable prototype.

Scoped child components are valid only in their declared hierarchy: Annotation in CodeDiff and CodeSnippet; Column in DataTable; Ddl in DatabaseTableSchema; Stage and Edge directly in FlowDiagram, with Node directly in that Stage; Entry in TableOfContents; Option directly in Decision, with Consideration directly in that Option; Criterion, Details, Option, and Reversibility directly in DecisionAnalysis, with Score directly in an Option; Option directly in QuickDecision; Param, Request, and Response in HttpEndpoint; Argument, Field, Returns, Operation, Variables, and Response in GraphqlOperation; Field, Error, Example, and Proto in GrpcMethod; and the screen and drawing vocabulary documented under Wireframe.