Comprehensive documentation for the matric-eval model evaluation framework.
- Architecture Overview - System design and component structure
- Vision - Project goals and scope
- Roadmap - Implementation timeline and milestones
- Testing Guide - How to run and write tests
Technical design documentation and architectural decisions.
- Overview (SAD) - Software Architecture Document
- Decisions (ADRs)
Product requirements and use case specifications.
- Vision - Project vision and business case
- Supplementary Requirements - Non-functional requirements
- Traceability Matrix - Requirements to implementation mapping
- Use Cases
Test strategy, plans, and contribution guidelines.
- Strategy - Overall testing approach
- Contributing - How to write and run tests
- Test Plans
CI/CD and release documentation.
- CI/CD Pipeline - Gitea Actions workflow
- Release Notes Template - Release documentation format
Planning and implementation guides.
- Planning - Architecture decisions and implementation plan
- Roadmap - Project timeline and milestones
- Checkpoint/Resume - Implementation details for fault tolerance
- Session Init - Development session initialization
Background research and academic references.
- Citable Claims Index - Referenced research papers
- Research Gap Analysis - Areas for improvement
- Self-Evaluation Research - LLM self-evaluation approaches
- Read the Vision to understand project goals
- Review the Architecture Overview for system design
- Check the Roadmap for current status
- See Testing Guide for development workflow