Repository navigation
docs: restructure the README around the SQLBuild layout - #7
Merged
Merged
Conversation
Co-authored-by: Kevin Longe <kvlonge@gmail.com>
Deploying sqlclean with
|
| Latest commit: |
8e2f216
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://28a04db9.sqlclean.pages.dev |
| Branch Preview URL: | https://docs-readme-sqlbuild-layout.sqlclean.pages.dev |
Co-authored-by: Kevin Longe <kvlonge@gmail.com>
…arks Co-authored-by: Kevin Longe <kvlonge@gmail.com>
This was referenced Oct 31, 2026
kvlonge
added a commit
that referenced
this pull request
Oct 31, 2026
* docs: restructure the README around the SQLBuild layout Co-authored-by: Kevin Longe <kvlonge@gmail.com> * docs: lead the README with speed and capabilities Co-authored-by: Kevin Longe <kvlonge@gmail.com> * docs: fill the README speed claim and table from the published benchmarks 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
The README had drifted from the site and carried a full command, configuration and custom Rule reference. Its relative image paths broke on PyPI, where the README is the package description.
Changes
Verification
sqlclean check0.81 s (median of 3; every round under 1 s) against 39.97 s for sqruff (49×; the published figure is 51×).readme_rendererpasses. A browser render shows the logo, headline, links and demo.