Phillip Tarrant
a376207243
Keeps repo root lean: CLAUDE.md is the only doc at root. All reference/architecture material lives under docs/. Also updates all cross-references in CLAUDE.md, docs/README.md, and the FastAPI override note in code_guidelines.md so links stay valid after the move. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
28 lines
961 B
Markdown
28 lines
961 B
Markdown
# Documentation Folder
|
|
|
|
This folder contains business planning, architecture decisions, and documentation.
|
|
|
|
**No application code belongs here.**
|
|
|
|
## Contents
|
|
|
|
| Document | Purpose |
|
|
|----------|---------|
|
|
| `ROADMAP.md` | Phased build plan, data model (dataclasses), SQL schema, visual design, env-var contract |
|
|
| `code_guidelines.md` | Generic Python coding standards (FastAPI overrides its Flask default for this project) |
|
|
| `security.md` | Python security baseline (OWASP-aligned) |
|
|
| `MANUAL_TESTING.md` *(added in Phase 1)* | Manual test checklist for the public site + admin |
|
|
|
|
## Related Docs (in repo root)
|
|
|
|
| Document | Purpose |
|
|
|----------|---------|
|
|
| `../CLAUDE.md` | Project instructions — stack, topology, security must-haves, git flow |
|
|
|
|
## Guidelines
|
|
|
|
- Keep documents focused and concise.
|
|
- Update docs when architecture decisions change.
|
|
- Use markdown tables for structured information.
|
|
- Link to external documentation where relevant.
|