31 lines
1.0 KiB
Markdown
31 lines
1.0 KiB
Markdown
# Documentation Index
|
|
|
|
This folder contains detailed technical documentation for the project.
|
|
|
|
## Suggested Reading Order
|
|
|
|
1. [Project Review](PROJECT_REVIEW.md)
|
|
2. [Architecture](ARCHITECTURE.md)
|
|
3. [Setup and Run](SETUP_AND_RUN.md)
|
|
4. [Configuration](CONFIGURATION.md)
|
|
5. [Testing](TESTING.md)
|
|
6. [Known Issues](KNOWN_ISSUES.md)
|
|
7. [Source Map](SOURCE_MAP.md)
|
|
|
|
## Document Guide
|
|
|
|
- [Project Review](PROJECT_REVIEW.md)
|
|
End-to-end implementation summary, design decisions, quality checks, and roadmap.
|
|
- [Architecture](ARCHITECTURE.md)
|
|
Component responsibilities, runtime data flow, and integration boundaries.
|
|
- [Setup and Run](SETUP_AND_RUN.md)
|
|
Reproducible setup for minimal and full integration modes.
|
|
- [Configuration](CONFIGURATION.md)
|
|
Complete key reference, validation behavior, and script environment mapping.
|
|
- [Testing](TESTING.md)
|
|
Test strategy, inventory, execution, and remaining gaps.
|
|
- [Known Issues](KNOWN_ISSUES.md)
|
|
Active limitations and impact.
|
|
- [Source Map](SOURCE_MAP.md)
|
|
Package-level map for fast code navigation.
|