docs: introduce wicked-sqlc architecture - #18
Merged
Conversation
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
Introduce wicked-sqlc with a concise architecture overview, a small working
example, and links to the guide and bookstore. Preserve the original upstream
README at the end.
Architecture and Key Decisions
GenerateRequest/WickedMetadatacontract, and dedicatedwicked backend against the implementation now on
main.one binary, selected by
sql_package: wpgx.tying the architecture to one version.
including its badges, links, and sponsors. No implementation or guide changes.
Risks and Remaining Work
No known issues. Architecture claims were checked against the compiler,
shim/proto, dispatcher, in-process handler, and backend.
Breaking Changes
None; documentation only.
Database Migrations
None.
Verification
git diff --check origin/mainpassed; only README and its changelog changed.make -n installconfirmed the build command without replacing the installedbinary. No
make lint-fixtarget exists.node /tmp/sqlc-readme-validation.1zZzaq/verify.mjspassed relative-link,code-fence, and exact README YAML/SQL fixture checks. It also verifies
version-neutral wording and byte-for-byte preservation of the upstream README.
sqlc generateandsqlc diff. Inspected the generated timeout, cache, replica,and load/dump code.
GitHub workflows run on this PR.
Merge Order
None; based directly on current
main.Related PRs
Follows the merged architecture work in #17.