docs: update local agents notes and remove stale image
This commit is contained in:
10
AGENTS.md
10
AGENTS.md
@@ -12,17 +12,23 @@
|
||||
- Technical docs live in `doc/` with `doc/README.md` as the index.
|
||||
|
||||
## Working Commands
|
||||
|
||||
### Docker
|
||||
If required to run the docker image, follow these steps:
|
||||
- Init VM: `multipass shell dcm-dev`
|
||||
- Move to VM WD: `cd ~/dcm`
|
||||
- Start full stack: `docker compose up --build -d`
|
||||
- Stop stack: `docker compose down`
|
||||
- Tail logs: `docker compose logs -f`
|
||||
|
||||
### Local NPM Build
|
||||
- Frontend dev only: `cd frontend && npm run dev`
|
||||
- Frontend production build: `cd frontend && npm run build`
|
||||
|
||||
## Validation
|
||||
- No automated test suite is currently committed.
|
||||
- Manual checks for code changes: `GET /api/v1/health`, upload + processing flow, search, document preview/download, and clean `docker compose logs -f` output for `api` and `worker`.
|
||||
- Manual checks for code changes inside VM: `GET /api/v1/health`, upload + processing flow, search, document preview/download, and clean `docker compose logs -f` output for `api` and `worker`.
|
||||
|
||||
## If You Add Tests
|
||||
- Backend: place near changed module, use `test_*.py`.
|
||||
- Frontend: use `*.test.tsx`.
|
||||
- Update `README.md` and `doc/README.md` with test run commands.
|
||||
|
||||
Reference in New Issue
Block a user