weave-compliance · docs
Source declarations, signatures and documentation for docs.
Reviewed implementation boundary: The compliance module contains prototype/placeholder behavior. Production in a type name does not establish implemented audit integrity, verified signatures, governance encryption, regulatory submission, or a compliance certification. Read /libraries/weave-compliance/overview and the corresponding task guide for current boundaries.
Source: sigil/weave/libs/weave-compliance/src/docs.rs. SHA-256: 2285a57bb021ec94630bfc38661018cee5d33f959bff4276d99f4e3f781f6dcd.
This reference follows declared source modules, retains conditional attributes, and includes public declarations and implementation methods. Private-module re-exports and trait resolution require the compiler; this is a source reference, not a claim that every listed item is a root import. Function bodies and constant values are omitted.
docs::ApiDocumentation
API documentation bundle (simplified) API documentation summary
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ApiDocumentation {
/// Endpoint list
pub endpoints: Vec<String>,
/// SDK language where applicable
pub sdk: Option<String>
}Source line: 8.
docs::ProtocolDocumentation
Protocol documentation
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ProtocolDocumentation {
/// protocol name
pub protocol_name: String,
/// overview
pub overview: String,
/// examples
pub examples: Vec<String>,
/// generated time
pub generated_at: chrono::DateTime<Utc>
}Source line: 17.
docs::DocumentationSuite
Documentation suite
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DocumentationSuite {
/// api docs
pub api_documentation: ApiDocumentation,
/// compliance docs summary
pub compliance_documentation: String,
/// operational docs summary
pub operational_documentation: String,
/// generated at time
pub generated_at: chrono::DateTime<Utc>,
/// version string
pub version: String
}Source line: 30.
docs::DocumentationGenerator
Generator for protocol docs
#[async_trait::async_trait]
pub trait DocumentationGenerator: Send + Sync {
/// Generate protocol docs
async fn generate_protocol_documentation(
&self,
protocol_name: &str,
) -> Result<ProtocolDocumentation>;
}Source line: 45.
docs::ComplianceDocumentationGenerator
Generate compliance docs
#[async_trait::async_trait]
pub trait ComplianceDocumentationGenerator: Send + Sync {
/// Create summary or full docs
async fn generate_compliance_documentation(&self) -> Result<String>;
}Source line: 55.
docs::DocumentationVersionManager
Version manager
#[async_trait::async_trait]
pub trait DocumentationVersionManager: Send + Sync {
/// Current version string
async fn get_current_version(&self) -> Result<String>;
}Source line: 62.
docs::ProductionDocumentationSystem
Production documentation system facade
pub struct ProductionDocumentationSystem<V: DocumentationVersionManager> {
}Source line: 68.
docs::ProductionDocumentationSystem<V>::new
Create new instance
pub fn new(version: V) -> Self;Source line: 74.
docs::ProductionDocumentationSystem<V>::generate_comprehensive_documentation
Generate a full suite
pub async fn generate_comprehensive_documentation(&self) -> Result<DocumentationSuite>;Source line: 79.
docs::ProductionComplianceDocs
Production compliance docs generator (placeholder)
pub struct ProductionComplianceDocs;Source line: 95.
docs::StaticVersionManager
Simple version manager reading from environment or static
pub struct StaticVersionManager(pub String);Source line: 105.
