ptarrant/chicken_babies_site
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: move code_guidelines and security under docs/

Browse Source 
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>
This commit is contained in:
Phillip Tarrant
2026-04-21 14:24:54 -05:00
parent 5f3bd69e95
commit a376207243
4 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
CLAUDE.md
View File

@@ -2,7 +2,7 @@
Small farm website for **Chicken Babies R Us** (Morrison TN — address is intentionally **not** displayed publicly). Public brochure site with a blog-style home, About, Contact, and a disabled "Shop (coming soon)" placeholder. The owner's wife, **Head Hen**, edits all content through an admin area protected by email magic-link authentication.
> This file is authoritative for *this project*. Where it conflicts with `code_guidelines.md`, this file wins.
> This file is authoritative for *this project*. Where it conflicts with `docs/code_guidelines.md`, this file wins.
---
@@ -11,7 +11,7 @@ Small farm website for **Chicken Babies R Us** (Morrison TN — address is inten
| Layer | Choice |
|---|---|
| Language | Python 3.12 |
| Web framework | **FastAPI** (overrides the Flask default in `code_guidelines.md`) |
| Web framework | **FastAPI** (overrides the Flask default in `docs/code_guidelines.md`) |
| Templates | Jinja2 |
| ASGI server | Uvicorn, behind Caddy reverse proxy |
| Database | SQLite (WAL mode) — single-writer is fine at this scale |
@@ -52,6 +52,8 @@ The app MUST trust `X-Forwarded-For` / `X-Forwarded-Proto` **only from Caddy's I
├── docs/ business + architecture docs (NO application code)
│ ├── README.md
│ ├── ROADMAP.md
│ ├── code_guidelines.md
│ ├── security.md
│ └── MANUAL_TESTING.md (added in Phase 1)
├── tests/ pytest
├── Logo/ brand assets (source)
@@ -60,12 +62,10 @@ The app MUST trust `X-Forwarded-For` / `X-Forwarded-Proto` **only from Caddy's I
├── requirements.txt
├── .env.example
├── .gitignore
├── CLAUDE.md
├── code_guidelines.md
└── security.md
└── CLAUDE.md
```
## Security Must-Haves (in addition to `security.md`)
## Security Must-Haves (in addition to `docs/security.md`)
- **SQL**: parameterized statements only (sqlite3 `?` placeholders or SQLAlchemy Core bind params). Never f-string a query.
- **Markdown**: hardened pipeline `markdown-it-py` → `bleach` allowlist. No raw HTML pass-through.
@@ -110,7 +110,7 @@ docker compose up --build
## Pointers
- Generic Python standards: `code_guidelines.md` (FastAPI overrides its Flask default)
- Security baseline: `security.md`
- Generic Python standards: `docs/code_guidelines.md` (FastAPI overrides its Flask default)
- Security baseline: `docs/security.md`
- Phased roadmap, dataclasses, SQL schema, visual design: `docs/ROADMAP.md`
- Docs folder guide: `docs/README.md`