Skip to content

renderSubsystemPage

reference
1 min readUpdated

Kind: Function

Source: atloria-monorepo/libs/parser-core/src/techdocs/subsystems.ts

A page for one subsystem: what it is, what reaches it, what it leans on, and how its files are named.

Every sentence here is derived from the resolved graph, and the page deliberately says less than a hand-written one would. It states what depends on this subsystem, where work enters, and which conventions its files follow — and then stops, rather than narrating a purpose nobody wrote down. A generated claim about why a subsystem exists is the one thing an AST cannot support, and inventing it is how generated documentation loses a reader's trust for good.

Signature

ts
function renderSubsystemPage(subsystem: Subsystem, all: Subsystem[], namingSection, responsibility, flowSection): string

Parameters

NameType
subsystemSubsystem
allSubsystem[]
namingSectionany
responsibilityany
flowSectionany

Returns: string

Was this page helpful?

Download as PDF