Weave documentation
Weave Compliance

Documentation

Documentation container types and static placeholder output.

Documentation interfaces

DocumentationGenerator, ComplianceDocumentationGenerator and DocumentationVersionManager describe generation/version boundaries. ProductionDocumentationSystem::new(version_manager) returns a DocumentationSuite when generate_comprehensive_documentation() is called.

The current suite contains static illustrative endpoint and summary strings, plus the version returned by the supplied manager. ProductionComplianceDocs returns a fixed text string. These implementations do not scan the current application API, generate source-backed Fumadocs pages, or assemble regulator-ready evidence.

Use StaticVersionManager only when the supplied version is the intended artifact version. Connect real schema/API inventories, runbooks and evidence sources to build application-specific documentation; keep those artifacts tied to their source revisions.

Source reference

Exact declarations and source provenance · Package features and manifest.

On this page