| name | rhizome-readme |
| description | Principles for structuring the Rhizome README |
The first principle is that onboarding is as easy and simple as possible,
and as unintrusive as possible. When a user has Docker, this should be
thusly the best fit.
All ports should be configurable at all times, to avoid annoyance on developers side.
Next, working alternatingly - not at the same time, but deciding on a case by case basis
depending on the task at hand - between working inside or outside of a container, should
be seemlessly possible.
Paths that should verifably work
Tests with Playwright (can be headless)
from the host system, and controlling another CMUX surface.
1 First docker box, then host, then docker yolo, then vector inside docker box
Assume
- Clojure, Babashka etc. are installed
Make sure
- No containers, no volumes exist which belong to Rhizome (delete them)
- node_modules on host does not exist (delete it)
- Configs are clean (run
make clean)
- a
docker/token exists
Steps
- Developer installs via Docker, using default ports, using
make box.
make test should work
make e2e should work
- Developer starts application inside container with
make start
- App should be reachable at 3140 (verify with Playwright), should show seed data
- Developer exists container and switches to host system
- Developer runs
npm i
make test should work
make e2e should work
- Developer starts the app from outside the container with
make start
- App should be reachable at 3140 on the host (verify with Playwright), should show seed data
- Developer stops the app with
make stop
- Developer runs
make yolo
- Inside the container, run
claude (bypass permissions mode is ok inside the container)
- Claude should indicate that it is logged in (try
/status)
/mcp should list playwright as connected
- Prompt "start the app and take a screenshot. call it abc1.png"
- Verify on the host system that the screenshot shows Rhizome seed data with Contexts on the LHS and Items on the RHS
- Exit container
make clean on host
make box WITH_VEC=1
make onboard
make start
make backfill-embeddings
- On host, system, filtering "Articles" by vector search, as shown in the README, should work