docs: fix README architecture drift (routes + packages match code) - #286
Merged
Conversation
The Architecture block listed endpoints and packages that do not exist and contradicted the repo itself: - Routes: dropped phantom /v1/sandbox/run and /v1/verify/batch; added the real /v1/health, /v1/verify/smt, /v1/verify/symbolic (verified against cmd/symkerneld/routes.go). - Packages: internal/compose -> internal/composed (real name); removed nonexistent internal/explain and internal/batch; added internal/criterion, internal/z3, internal/verify. - Corrected internal/smt from "go-z3 CGO binding" to the z3 subprocess reality -- README already states symkerneld does NOT use CGO and shells out to "z3 -in", so the old line was self-contradictory. - Batch verification section reframed as planned (no /v1/verify/batch route or SYMKERNEL_BATCH_CONCURRENCY exists in code), matching the repo's planned convention rather than documenting a 404 as live. Docs only; verified every route/package against main.
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
1 participant
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.
The Architecture block described endpoints and packages that do not exist, and contradicted the README itself.
Verified against
cmd/symkerneld/routes.goand theinternal/tree on main:/v1/sandbox/runand/v1/verify/batch; added the real/v1/health,/v1/verify/smt,/v1/verify/symbolic.internal/compose→internal/composed(real name); removed nonexistentinternal/explainandinternal/batch; addedinternal/criterion,internal/z3,internal/verify.internal/smtwas labelled a "go-z3 CGO binding", but the README already states symkerneld does not use CGO and shells out toz3 -in. Corrected to the subprocess reality (bothinternal/z3andinternal/smtshell out toz3)./v1/verify/batch(andSYMKERNEL_BATCH_CONCURRENCY) exist nowhere in code; reframed the section as planned rather than documenting a 404 as a live endpoint.Docs only.