Cleanroom Labs home Cleanroom Labs
About Blog Docs
Development documentation — may change at any time
Technical Documentation

Projects

  • AirGap Transfer
    • Quick Links
    • Key Features
    • Project Status
    • Core Principles
    • Common Scenarios
    • Related Projects
  • AirGap Deploy
    • Quick Links
    • Key Features
    • Project Status
    • Core Principles
    • Example Use Cases
    • Related Projects
  • Cleanroom Whisper
    • Quick Links
    • Key Features
    • Project Status
    • Core Principles
    • Related Projects

General Information

  • Licensing
    • Open Source License
    • Commercial Licensing
    • Contact
  • Scope & Limitations
    • Scope of the AirGap Suite
    • Limits of Applicability
      • AirGap Transfer
      • AirGap Deploy
      • Cleanroom Whisper
    • Disclaimer of Warranty
    • Limitation of Liability
    • Security Considerations
  • Competitive Landscape
    • Per-Project Competitive Analysis
      • AirGap Transfer
      • AirGap Deploy
      • Cleanroom Whisper
    • Integrated Suite Comparison

Design

  • Principles
    • Privacy Through Data Locality
      • What this means
      • How to verify
      • Implementation rules
      • Air-gap deployment
      • Build dependencies
    • Minimal Dependencies
      • Target
      • Technology constraints
    • Simple Architecture
      • File structure
    • Features We Don’t Build
    • Design Principles Alignment
  • Meta-Architecture
    • Project Overview
    • Architecture Diagram
    • Project Relationships
      • Cleanroom Whisper ↔ AirGap Deploy
      • AirGap Deploy ↔ AirGap Transfer
      • Cleanroom Whisper ↔ AirGap Transfer
    • Use Cases
    • Dependency Analysis
      • Compile-Time Dependencies
      • Runtime Dependencies
      • Workflow Dependencies
    • Project Boundaries
      • Cleanroom Whisper
      • AirGap Deploy
      • AirGap Transfer

Systems Engineering

  • Specification Overview
    • Artifact Types
    • Traceability Chain
    • Requirements by Category
      • Cleanroom Whisper
      • AirGap Transfer
      • AirGap Deploy
  • Documentation Standards Framework
    • IEEE Standards Alignment
    • Artifact Type Schema
    • How Standards Are Applied
    • See Also
  • Writing Good Specifications
    • Writing Requirements
    • Writing Use Cases
    • Writing Test Cases
    • Writing Design Specifications
    • Common Mistakes
    • See Also

Project Management

  • Release Philosophy
    • v1.0.0: Coordinated Launch
    • Post-v1.0.0: AirGap Synchronized, Whisper Independent
    • Versioning Rules
      • Patch Releases
      • Minor Releases
      • Major Releases
  • Release Roadmap
    • v1.0.0 Release Criteria
      • AirGap Deploy v1.0.0
      • AirGap Transfer v1.0.0
      • Cleanroom Whisper v1.0.0
      • v1.0.0 Quality Bar
    • v1.0.0 Milestone Plan
      • Milestone Details
    • Cross-Project Integration Milestones
      • Integration Scenario: Ollama Deployment
    • Individual Project Roadmaps
      • Progress Log
  • Project Statistics
    • AirGap Transfer
    • AirGap Deploy
    • Cleanroom Whisper
    • Suite-Wide Summary
    • See Also
  • v1.1 Planning
    • AirGap Deploy v1.1
    • AirGap Transfer v1.1
    • Cleanroom Whisper v1.1
    • Timeline
    • Proposed Artifacts
      • AirGap Deploy
      • AirGap Transfer

Developer Resources

  • Sphinx Needs Usage Guide
    • What is sphinx-needs?
    • Why Use sphinx-needs?
    • Creating Needs
      • Basic Syntax
      • Use Case Example
      • Functional Requirement Example
      • Non-Functional Requirement Example
      • Test Case Example
      • Implementation Example (Future)
    • Linking Needs
      • Link Types
      • Link Syntax
      • Viewing Links
    • Generating Traceability Matrices
      • needtable Directive
      • Common Filters
      • Column Options
      • Requirements to Tests Table
    • Creating Flow Diagrams
      • needflow Directive
      • Full Traceability Diagram
      • Focused Diagrams
    • Best Practices
      • ID Naming Conventions
      • Status Values
      • Priority Values
      • Tags
      • Writing Good Descriptions
    • Validation
      • Build-Time Checks
      • Coverage Checking
    • Common Tasks
      • Adding a New Requirement
      • Adding a New Test Case
      • Updating Traceability
    • Troubleshooting
      • Duplicate ID Error
      • Broken Link Error
      • Missing in Traceability Matrix
    • Summary
    • See Also
  • Rust API Documentation Integration Guide
    • Overview
    • Prerequisites
    • Writing Traceable Rust Doc Comments
      • Standard Doc Comment Structure
      • Requirement References
      • Module-Level Documentation
    • Configuring sphinxcontrib-rust
      • Step 1: Update conf.py
      • Step 2: Generate Rust Documentation
      • Step 3: Reference Rust Items in RST
    • Linking Code to Requirements
      • Implementation Directives
      • Updating Traceability Matrix
    • Building Documentation
      • Local Build with Rust Docs
      • GitHub Actions Integration
    • Best Practices
      • Documentation Quality
      • Traceability Maintenance
      • Code Organization
    • Troubleshooting
      • Rust Docs Not Appearing
      • Broken Cross-References
      • Missing Requirement Links
    • Examples
      • Complete Example: Cleanroom Whisper Audio Module
    • Summary
    • See Also
  • Developer Guidelines
    • Licensing Overview
    • Contributor Expectations
    • AGPL Compliance
    • Third-Party Dependencies
    • Coding Conventions
      • Before Adding a Dependency
      • Code Rules
      • The YAGNI Test
      • Code Style
      • Testing Expectations
      • Documentation Standards
      • Git Workflow
Technical Documentation
  • Search

© Copyright 2026, Cleanroom Labs. Last updated on 2026-02-18.