docs: describe the API surface the README actually reaches - #217
Merged
Conversation
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) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Member
Author
Self-review rubric
Findings folded in from the diff read
Anchor scopeCI's Java This review was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
actually reachable through the controllers. Renaming (entities, grids, environments), the
unassigned-entity query, the unoccupied-locations-in-a-grid query, neighbor lookup, occupancy
reporting, entity listing at a location, and the adjacency-checked move were all absent.
only update the environment surface offers, so the broader wording promised more than exists.
PLANNING.md,REBUILD_PLAN.md, anddiagrams/alongside
MVP.mdandopenapi/, with each described from what the file/directory holds(
diagrams/holds a draw.io class-usage diagram and its rendered PNG, not Mermaid sources).Every claim was checked against
src/main/java/preponderous/viron/controllers/*.javarather thanagainst
docs/MVP.md, as the issue's acceptance criteria ask. The two documents agree: all 36routes are present in both.
Test plan
README.mdonly.updateEntityName,updateGridName,updateEnvironmentName,getEntitiesNotInAnyLocation,getUnoccupiedLocationsInGrid,getNeighbors,isLocationOccupied,getEntityIdsAtLocation,addEntityToLocation,moveEntityToLocation,removeEntityFromLocation,removeEntityFromCurrentLocation.docs/listing verified against the directory as it stands onmain.Issues left for a later cycle
The rest of the open backlog was not picked up, for reasons recorded here rather than as comments
on each issue:
API contract; it is stated in the issue as two coherent, opposed answers and wants a human choice
before any code moves.
compose.ymland application configuration, whichare do-not-auto-merge paths for this loop and larger than a polish-sized change.
requirements.txt, a newproject file, import paths across the client and its tests) and does not batch with a docs fix.
path.
Closes #215
This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
drafted by Claude on behalf of Daniel Stephenson