24713ce5e6
- Rebrand LoginPage logo to Oliver design system - Move Admin nav link to bottom-left user area - Remove "Ask AI to improve" button from step 2 (VariantsGrid) - Add CharCount component with copy limits across prompt, edit, and export views - Add delete variant with confirmation dialog on step 2 cards - Add theme palette migration (0007_theme_palette.py) - Add copyLimits.ts and themes.ts libs - Remove unused BannerEditor.tsx page and old logo PNG - Add AGENTS.md project entry point - Add docs/ directory Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| project | ||
| reference | ||
| tasks | ||
| README.md | ||
Barclays BMB Banner Visualiser — Documentation Hub
What This Docs Folder Contains
| Section | Path | Purpose |
|---|---|---|
| Project core | docs/project/ |
Architecture, tech stack, API, DB, infra, runbook, requirements |
| Reference | docs/reference/ |
ADRs, guides, research |
| Tasks | docs/tasks/ |
Backlog, active work, completed items |
Project Docs
| Document | One-line summary |
|---|---|
| architecture.md | System components, data flow, job state machine, RAG pipeline |
| tech_stack.md | All dependency versions, config, environment variables |
| api_spec.md | Every HTTP endpoint — method, path, auth, request, response |
| database_schema.md | All tables, columns, types, indexes, relationships |
| infrastructure.md | Server, Docker services, Apache config, ports, volumes |
| runbook.md | Local setup, deploy, restart, rollback, logs, common fixes |
| requirements.md | Functional requirements mapped to implementation |
Reference
| Document | Purpose |
|---|---|
| reference/README.md | Index of all ADRs and reference articles |
| reference/adrs/ | Architecture Decision Records |
Tasks
| Document | Purpose |
|---|---|
| tasks/README.md | Active and pending work items |
How to Keep Docs Current
- Update architecture.md when a new service or worker task is added
- Update api_spec.md when a route is added, changed, or removed
- Update database_schema.md when a new Alembic migration is created
- Update runbook.md when deploy steps or commands change
- Create a new ADR for any non-trivial technology or design decision
- Update tasks/README.md when work items are completed or created