# Documentation Guide — denote

This file indexes all project documentation. Read it first to find the right
doc for your current task.

## Core Documentation

| Document | Purpose | When to read |
|----------|---------|-------------|
| [architecture.md](architecture.md) | System design, component relationships, data flow | Understanding how the project is structured |
| [conventions.md](conventions.md) | Code style, naming patterns, project-specific rules | Before writing or reviewing code |
| [known_issues.md](known_issues.md) | Known bugs, quirks, and workarounds | Before investigating a bug or unexpected behavior |

## Additional Documentation

| Document | Purpose | When to read |
|----------|---------|-------------|
| [Audio-to-Symbol -- A Comprehensive Survey of Automatic Music Transcription and MIR Tools.md](Audio-to-Symbol -- A Comprehensive Survey of Automatic Music Transcription and MIR Tools.md) | | |
| [Music Transcription Tools Research.md](Music Transcription Tools Research.md) | | |
| [arioso_design_notes.md](arioso_design_notes.md) | | |
| [backend_api_comparison.md](backend_api_comparison.md) | | |
| [roadmap.md](roadmap.md) | | |

## How to Use These Docs

- **Starting a new task?** Check `architecture.md` for context, then `conventions.md` for rules.
- **Hit a bug?** Check `known_issues.md` first — it may already be documented.
- **Making a design decision?** Record it in `decisions/` using the MADR template.
