docs(project): sync docs with code and bump to 3.0.0
Prepare the 3.0.0 release: - Bump the version in openapi.yaml and frontend/package.json to 3.0.0. - Document the existing GET /health endpoint in openapi.yaml (served at the root, outside /api/v1) and refine the auth note. - Add docs/REQUIREMENTS.md (product requirements, in English) and docs/ARCHITECTURE.md (system overview); remove the old Russian docs/Описание.md. - Rewrite GO_PROJECT_STRUCTURE.md and FRONTEND_STRUCTURE.md to match the current code (dedup CLI, imagehash, real components/stores, Tailwind v4). - Fix stale counts and references in CLAUDE.md and link the new docs from README.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -13,16 +13,18 @@ Monorepo: `backend/` (Go) + `frontend/` (SvelteKit).
|
||||
|
||||
## Key documents (read before coding)
|
||||
|
||||
- `openapi.yaml` — full REST API specification (36 paths, 58 operations)
|
||||
- `openapi.yaml` — full REST API specification (44 paths, 67 operations)
|
||||
- `docs/REQUIREMENTS.md` — product requirements (functional + non-functional)
|
||||
- `docs/ARCHITECTURE.md` — system architecture overview (layers, data flow, decisions)
|
||||
- `docs/GO_PROJECT_STRUCTURE.md` — backend architecture, layer rules, DI pattern
|
||||
- `docs/FRONTEND_STRUCTURE.md` — frontend architecture, CSS approach, API client
|
||||
- `docs/Описание.md` — product requirements in Russian
|
||||
- `backend/migrations/001_init.sql` — database schema (4 schemas, 16 tables)
|
||||
- `backend/migrations/` — database schema as goose migrations (4 schemas, 19 tables)
|
||||
|
||||
## Design reference
|
||||
|
||||
Visual design tokens for the frontend (carried over from the previous
|
||||
Python/Flask version):
|
||||
|
||||
- Color palette: #312F45 (bg), #9592B5 (accent), #444455 (tag default), #111118 (elevated)
|
||||
- Font: Epilogue (variable weight)
|
||||
- Dark theme is primary
|
||||
@@ -32,6 +34,7 @@ Python/Flask version):
|
||||
- Floating selection bar for multi-select
|
||||
|
||||
## Backend commands
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
go run ./cmd/server # run dev server
|
||||
@@ -39,6 +42,7 @@ go test ./... # run all tests
|
||||
```
|
||||
|
||||
## Frontend commands
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm run dev # vite dev server
|
||||
|
||||
Reference in New Issue
Block a user