Function: auditDocs()
August 8, 2026 ยท View on GitHub
@plures/praxis / index / auditDocs
Function: auditDocs()
auditDocs(
rootDir,config):DocsAuditResult
Defined in: src/lifecycle/docs.ts:216
Scan a repository and audit its documentation state.
Parameters
rootDir
string
The root directory of the repository to scan
config
Documentation configuration specifying which files and templates to track
Returns
A DocsAuditResult with coverage scores and per-document status