From 9cf97a995a4b9f8d09c949eb5218e634f448716f Mon Sep 17 00:00:00 2001 From: Daniel McCoy Stephenson Date: Thu, 10 Sep 2026 01:51:36 -0600 Subject: [PATCH 1/2] docs: describe the API surface the README actually reaches The feature list omitted renaming, the unassigned-entity and unoccupied-location queries, neighbor lookup, occupancy reporting, and the move endpoint. The project structure listing named only two of the five things under docs/. Closes #215 Co-Authored-By: Claude Opus 5 (1M context) --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2371e27..2568975 100644 --- a/README.md +++ b/README.md @@ -50,20 +50,27 @@ Core responsibilities: The MVP implements the endpoints defined in `docs/openapi/viron-api.json` and documented in `docs/MVP.md`. **Environment Management** -- Create, retrieve, update (including renaming), and delete environments. +- Create, retrieve, rename, and delete environments. - Create grids as squares (`gridSize`) or with independent dimensions (`numRows`/`numColumns`). - Query environments by ID, name, or contained entity. **Grid Management** - Retrieve grids by ID or environment. - Find the grid containing a specific entity. +- Rename a grid. **Location Management** - Retrieve locations by ID, grid, or environment. -- Manage entity placement in locations. +- Place an entity at a location, move a placed entity to an adjacent location, and remove it + from a location or from wherever it currently stands. +- Ask which entities a location holds, whether it holds any at all, and which locations in a + grid hold none. +- Ask which locations neighbor a location within its grid. **Entity Management** -- Create, retrieve, and delete entities. +- Create, retrieve, rename, and delete entities. +- Query entities by environment, grid, or location, and list the entities that are not placed + anywhere. **Debug Utilities** - Generate sample environments, grids, locations, and entities. @@ -113,6 +120,9 @@ viron/ ├── db-scripts/ # SQL schema setup scripts, and migrations for existing databases ├── docs/ │ ├── MVP.md # Implementation checklist for MVP + │ ├── PLANNING.md # MVP issue plan, grouped into milestones + │ ├── REBUILD_PLAN.md # Process and conventions for the ground-up rebuild + │ ├── diagrams/ # Class-usage diagram (draw.io source and rendered PNG) │ └── openapi/ │ └── viron-api.json # API specification ├── postman/ # Postman collection generated from the API specification From e2a8f9fa549664ac84ee26651c4af2c54fa9a94f Mon Sep 17 00:00:00 2001 From: Daniel McCoy Stephenson Date: Thu, 10 Sep 2026 01:53:39 -0600 Subject: [PATCH 2/2] docs: keep the location bullets in the section's imperative voice Co-Authored-By: Claude Opus 5 (1M context) --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2568975..9d02be7 100644 --- a/README.md +++ b/README.md @@ -63,9 +63,9 @@ The MVP implements the endpoints defined in `docs/openapi/viron-api.json` and do - Retrieve locations by ID, grid, or environment. - Place an entity at a location, move a placed entity to an adjacent location, and remove it from a location or from wherever it currently stands. -- Ask which entities a location holds, whether it holds any at all, and which locations in a - grid hold none. -- Ask which locations neighbor a location within its grid. +- Retrieve the entities a location holds, report whether it holds any at all, and find the + locations in a grid that hold none. +- Retrieve the locations adjacent to a location within its grid. **Entity Management** - Create, retrieve, rename, and delete entities.