docs: bootstrap project instructions and roadmap
Add CLAUDE.md with authoritative stack (FastAPI + Jinja2 + SQLite), deployment topology (CF-proxied -> OPNsense -> Caddy -> VM), security must-haves, magic-link auth, and project git flow. Add docs/ROADMAP.md with phased build plan, dataclasses, SQL schema, caching strategy, visual design tokens (light-blue farm palette), and .env contract. Commit generic code_guidelines.md and security.md, note FastAPI per-project override. Add docs/README.md. Commit logo assets and .gitignore (venv, .env, data/, SQLite, caches). No app code in this pass. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
27
docs/README.md
Normal file
27
docs/README.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# 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 |
|
||||
| `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 |
|
||||
| `../code_guidelines.md` | Generic Python coding standards (FastAPI overrides its Flask default for this project) |
|
||||
| `../security.md` | Python security baseline (OWASP-aligned) |
|
||||
|
||||
## Guidelines
|
||||
|
||||
- Keep documents focused and concise.
|
||||
- Update docs when architecture decisions change.
|
||||
- Use markdown tables for structured information.
|
||||
- Link to external documentation where relevant.
|
||||
Reference in New Issue
Block a user