docaudit

package

v0.1.18 Latest Latest Go to latest Published: Mar 17, 2026 License: MIT Imports: 7 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Auditor struct {
	// contains filtered or unexported fields
}

Auditor checks for documentation drift in a repository.

func New(repoRoot string) *Auditor

New creates an Auditor rooted at the given repository path.

func (a *Auditor) Run() ([]Finding, error)

Run executes all documentation checks and returns findings.

type Finding struct {
	File     string
	Line     int
	Severity Severity
	Message  string
}

Finding represents a single documentation drift issue.

type Severity string

Severity indicates the importance of a finding.

const (
	SeverityError   Severity = "error"
	SeverityWarning Severity = "warning"
	SeverityInfo    Severity = "info"
)