This directory contains comprehensive documentation for the TMI (Threat Modeling Interface) project, organized by audience and purpose.
📋 agent/ - AI Agent Context Documentation
Documentation primarily intended to give context to AI agents working on the TMI project.
🛠️ developer/ - Development Documentation
Everything developers need to build, test, and integrate with the TMI server.
🚀 operator/ - Operations Documentation
Deployment, operations, and troubleshooting guidance for running TMI in production.
📖 reference/ - Reference Materials & Architecture
Pure reference materials, specifications, and architectural documentation.
Start with developer/setup/development-setup.md for local development environment setup.
Begin with operator/deployment/deployment-guide.md for production deployment.
Review developer/integration/client-integration-guide.md for client integration patterns.
Context and instructions are available in the agent/ directory.
- File Naming: All documentation uses
kebab-case.mdnaming convention - Cross-References: Links are maintained between related documents
- Audience-Focused: Each directory serves a specific audience with clear purpose
- Comprehensive Coverage: Every aspect of TMI development and operations is documented
- Testing Guide - Comprehensive testing documentation
- Coverage Reporting
- WebSocket Testing
- CATS Public Endpoints
- CATS OAuth False Positives
When adding new documentation:
- Choose the appropriate directory based on primary audience
- Use descriptive, hyphenated filenames
- Include comprehensive README updates
- Add cross-references to related documents
- Follow the established directory structure
For questions about documentation organization or to suggest improvements, please create an issue in the project repository.