@maverickcer/env-cap
    Preparing search index...

    Interface DocumentationFindings

    Everything generateDocumentation found that isn't fully documented or up to date -- never blocks generation; a team that wants to gate CI on this reads Finding[] (the "documentation" family) from the persisted evidence artifact and decides for itself. See ADR 0038.

    interface DocumentationFindings {
        expiringSoon: readonly ExpiringEntry[];
        nonstandardSensitivityLevels: readonly NonstandardSensitivityEntry[];
        staleDocEntries: readonly { exportName: string; file: string; key: string }[];
        undocumentedContracts: readonly { exportName: string; file: string }[];
        undocumentedVariables: readonly {
            exportName: string;
            file: string;
            key: string;
        }[];
        unresolvedLinks: readonly { file: string; reason: string }[];
    }
    Index
    expiringSoon nonstandardSensitivityLevels staleDocEntries undocumentedContracts undocumentedVariables unresolvedLinks
    expiringSoon: readonly ExpiringEntry[]

    Variables whose expiresAt falls within the configured window.

    nonstandardSensitivityLevels: readonly NonstandardSensitivityEntry[]

    Contract- or variable-level sensitivity values outside STANDARD_SENSITIVITY_LEVELS. Advisory only -- the declared level is always honored verbatim; this exists purely so vocabulary drift across a repo stays visible.

    staleDocEntries: readonly { exportName: string; file: string; key: string }[]

    Documented variable entries with no matching schema variable (the schema key was removed or renamed).

    undocumentedContracts: readonly { exportName: string; file: string }[]

    Contracts with no linked documentEnv() call at all.

    undocumentedVariables: readonly {
        exportName: string;
        file: string;
        key: string;
    }[]

    Schema variables with no matching entry in their contract's linked documentation.

    unresolvedLinks: readonly { file: string; reason: string }[]

    documentEnv() calls that couldn't be statically linked to a schema.

    Settings
    Member Visibility

    On This Page
    Properties