Variable: docs

August 8, 2026 ยท View on GitHub

@plures/praxis


@plures/praxis / index / docs

Variable: docs

const docs: object

Defined in: src/lifecycle/docs.ts:437

Built-in trigger actions for the documentation lifecycle phase (auditing, updating, and validating project docs).

Type Declaration

audit()

audit(config): TriggerAction

Audit documentation and report status.

Parameters

config

DocsConfig

Returns

TriggerAction

gate()

gate(): TriggerAction

Gate: docs must be updated before QA can proceed.

Returns

TriggerAction

plan()

plan(config): TriggerAction

Plan documentation updates based on code changes.

Parameters

config

DocsConfig

Returns

TriggerAction

validate()

validate(config): TriggerAction

Validate all docs against templates.

Parameters

config

DocsConfig

Returns

TriggerAction