Phillip Tarrant
53e62f694f
Remove phase implementation plans, design notes, and source spreadsheet that are no longer needed. Add architecture.md, API_REFERENCE.md, and database_schema.md for ongoing development and debugging reference. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
24 lines
806 B
Markdown
24 lines
806 B
Markdown
# Documentation
|
|
|
|
This folder contains architecture, API reference, and development documentation.
|
|
|
|
**No application code belongs here.**
|
|
|
|
## Contents
|
|
|
|
| Document | Purpose |
|
|
|----------|---------|
|
|
| `architecture.md` | App architecture, layers, patterns, request lifecycle |
|
|
| `API_REFERENCE.md` | All 23 endpoints with params, auth, and response details |
|
|
| `database_schema.md` | All 8 tables, columns, relationships, migrations |
|
|
| `code_guidelines.md` | Coding standards and Git strategy |
|
|
| `security.md` | Python-focused security guidance |
|
|
| `roadmap.md` | Feature status and future plans |
|
|
|
|
## Guidelines
|
|
|
|
- Keep documents focused and concise
|
|
- Update docs when architecture decisions change
|
|
- Use markdown tables for structured information
|
|
- Include links to external documentation where relevant
|