Developer Documentation

This section contains technical documentation for developers working on NLSQ, including architecture overview, performance optimization guides, CI/CD pipeline documentation, release management, development best practices, and Architecture Decision Records (ADRs).

• Architecture Overview
  • Package Structure
  • Architectural Layers
  • Core Optimization Pipeline
  • Streaming Optimization
  • Facades
  • Protocol-Based Dependency Injection
  • Result Types
  • Caching and Performance
  • Numerical Stability
  • Precision Modules
  • Global Optimization
  • Security Architecture
  • Diagnostics System
  • CLI System
  • Qt GUI System
  • Design Patterns
  • Data Flow Diagrams
  • Performance Optimizations
  • Environment Variables
  • Configuration System
  • See Also
• NLSQ Optimization Case Study: When to Stop Optimizing
  • Executive Summary
  • Table of Contents
  • Project Context
  • Initial Assessment
  • The Profiling Revelation
  • Optimization Implementation
  • Results and Analysis
  • The Decision to Stop
  • Lessons Learned
  • Recommendations
  • Conclusion
  • Appendices
• NLSQ Performance Tuning Guide
  • Recent Optimizations (v0.4.2+)
  • Quick Start
  • Understanding NLSQ Performance
  • Optimization Techniques
  • Profiling Your Workload
  • Common Performance Issues
  • Advanced Optimization
  • Benchmarking Checklist
  • Performance Expectations
  • Getting Help
  • Summary
• Documentation Quality Assurance
  • Zero Warnings Policy
  • Automated Checks
  • Common Documentation Issues
  • Best Practices
  • Troubleshooting
  • Metrics and Monitoring
  • References
  • See Also
• PyPI Publishing Setup Guide
  • Setting up GitHub Secrets for PyPI Publishing
  • Testing the Workflow
  • Verification
• Notebook Configuration Utilities
  • Overview
  • Architecture
  • Command-Line Interface
  • Available Transformations
  • Incremental Processing
  • Parallel Processing
  • Advanced Usage
  • Error Handling and Rollback
  • Best Practices
  • Pre-commit Hook Integration
  • Troubleshooting
  • See Also
• CI/CD Documentation
  • GitHub Actions - Developer Guide
  • Overview
  • Workflow Files
  • GitHub Actions Guide
  • Local Testing
• Architecture Decision Records (ADRs)
  • What is an ADR?
  • ADR Template
  • Index of ADRs
  • When to Create an ADR
  • References

Contributing

For contribution guidelines, see the main repository:

• CONTRIBUTING.md

• Code of Conduct

• Issue Tracker