Repository navigation
docs: polish the README header, opening, demo and benchmark table - #10
Merged
Merged
Conversation
Use transparent light and dark header logos in a picture element, with the light logo as the fallback for PyPI. Merge the speed line and the navigation into one centred block and make the intro left-aligned. Re-record the check-fix demo to show a NULL comparison, a safe fix that removes an unused CTE, a custom Rule finding, and the unsafe IS NULL fix applied only with --unsafe-fixes. Name the ratio column "Time relative to sqlclean check" and move Quick start after Speed. Co-authored-by: Kevin Longe <kvlonge@gmail.com>
…ull request Co-authored-by: Kevin Longe <kvlonge@gmail.com>
Deploying sqlclean with
|
| Latest commit: |
425f9cd
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d2422a83.sqlclean.pages.dev |
| Branch Preview URL: | https://docs-readme-polish.sqlclean.pages.dev |
kvlonge
added a commit
that referenced
this pull request
Oct 31, 2026
* docs: polish the README header, opening, demo and benchmark table Use transparent light and dark header logos in a picture element, with the light logo as the fallback for PyPI. Merge the speed line and the navigation into one centred block and make the intro left-aligned. Re-record the check-fix demo to show a NULL comparison, a safe fix that removes an unused CTE, a custom Rule finding, and the unsafe IS NULL fix applied only with --unsafe-fixes. Name the ratio column "Time relative to sqlclean check" and move Quick start after Speed. Co-authored-by: Kevin Longe <kvlonge@gmail.com> * docs: trim the README logo padding and explain recovering a release pull request Co-authored-by: Kevin Longe <kvlonge@gmail.com> ---------
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.
Why
Review of the new README found five issues: the black logo rectangle, a fragmented centred opening, a demo built mostly on style findings, an ambiguous ratio column, and Quick start buried after the custom Rule example.
Changes
<picture>, with the light logo as the fallback that PyPI shows. Made from the existing logo artwork and sized close to SQLBuild's header. The oldsqlclean-logo.pngstays, because the 0.1.0 PyPI page still loads it.sqlclean checkreports an unused CTE (safe fix), a custom Rule finding (no fix) and= NULL(unsafe fix).sqlclean fixremoves the CTE and formats the file, but leaves= NULL.sqlclean fix --unsafe-fixesrewrites it toIS NULL.sqlclean check". The numbers are unchanged, from the published benchmarks page.Verification