Repository navigation
docs: name the real debug switch and list the teardown script - #271
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (anchored on CI run 43673591074:
Out-of-diff observation, recorded without a fix:
Summary: a docs-only correction of two verified drifts. CI is green, nothing is left to address, and the PR is ready to merge. This review comment 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
A Stage A documentation accuracy sweep was run against the source. Two drifts were found and fixed. No code is changed.
docs/REBUILD_PLAN.md: the Notes section said debug tools are kept behindspring.profiles.active=debug. No profile is used anywhere in the repository.DebugControlleris@ConditionalOnProperty(prefix = "viron.debug", name = "enabled", havingValue = "true"), fed byviron.debug.enabled=${VIRON_DEBUG_ENABLED:false}inapplication.properties. The note now names that property and its environment variable.README.md: the project-structure tree describeddb-scripts/as setup scripts and migrations, but left outdb-scripts/teardown/delete_tables.sql. The teardown script is now listed.What the sweep checked and found consistent
docs/openapi/viron-api.json: all 37 routes match in both directions. This was checked with a throwaway script that is not committed.docs/MVP.mdchecklist vs. the spec: 37 endpoints and the DTO list agree. Its claims about placement, move and removal behaviour were checked againstLocationController.200/201/204) in the spec vs. the@ResponseStatusannotations on every controller method: all agree.NotFoundException,ConflictExceptionandInvalidRequestExceptionthrown by a controller sits on a route whose spec lists the matching404/409/400.README.mdconfiguration tables vs.application.properties,compose.ymlandsample.env: all agree.Skipped issues
All four open issues were deferred this cycle:
pom.xml) is still beyond a single-cycle scope, for the reason recorded on that issue.Test plan
README.md,docs/REBUILD_PLAN.md); no Java or Python file is touched.DebugController.java:38,application.properties:31anddb-scripts/teardown/.No tracking issue. The gap was found during the documentation sweep.
This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
🤖 Generated with Claude Code
drafted by Claude on behalf of Daniel Stephenson