Technical Design Index¶

This index organizes all technical design documents for the loryth project.

🚀 Active¶

📝 Draft¶

🟢 Accepted¶

📦 Archived¶

✅ Implemented¶

📚 Document Groups¶

Reflection System Foundation¶

• TD-001: Centralized metrics system for observability
• TD-002: Naming improvements to replace "BasicX" prefixes
• TD-003: Unified, ergonomic API surface
• TD-004: Modular architecture splitting large files
• TD-005: Code cleanup removing unused elements
• TD-006: Test suite reorganization
• TD-027: ReflectionContext API simplification (phase A of roadmap 002)
• TD-028: Hierarchical metrics architecture with aggregation (phase B of roadmap 002)

Dependency Injection System¶

• TD-007: Test quality improvements
• TD-008: Complexity metrics tooling
• TD-009: DI container consolidation
• TD-010: Bootstrapping system
• TD-011: Injection system
• TD-012: Enhanced annotations
• TD-013: Package scanning and auto-discovery
• TD-019: Configuration binding and sources
• TD-020: External bootstrap orchestration
• TD-022: Unified runtime marker system (replaces annotations module)

Test Quality Improvement¶

• TD-024: Universal test quality standards and meta-framework
• TD-025: Unit test quality standards and best practices
• TD-026: Integration test quality standards and best practices

👥 For Contributors¶

Technical Design Process¶

Technical designs follow a standard lifecycle:

flowchart TB
    A["📝 Draft"] --> B["Proposed"]
    B --> C["🟢 Accepted"]
    C --> D["✅ Implemented"]
    B --> F["🚫 Rejected"]
    C --> G["❌ Cancelled"]

Status Definitions:

• 📝 Draft - Design under development/review (not yet approved)
• Proposed - Ready for review and feedback
• 🟢 Accepted - Approved for implementation
• ✅ Implemented - Fully implemented and tested
• 🚫 Rejected - Design not approved for implementation
• ❌ Cancelled - Implementation was started but later cancelled

Using the Template¶

• Template: Canonical TD Template (project-wide)
• Writing Guide: Documentation Guidelines (project-wide)
• Flexibility: Not all sections are mandatory — adapt to your specific needs
• Customization: Section titles can be changed to better fit your design
• Housekeeping: Regularly archive completed designs and update this index

Best Practices¶

• Keep designs focused and scoped appropriately
• Include implementation considerations and alternatives
• Update status as work progresses
• Archive completed designs promptly

🔗 Related Documentation¶

• Dependency Injection Roadmap
• Contributing Guidelines
• Project Documentation

This index is maintained by the loryth contributors. Please update it when adding or modifying technical design documents.