Skip to content

docs: restructure the README around the SQLBuild layout - #7

Merged
kvlonge merged 3 commits into
mainfrom
docs/readme-sqlbuild-layout
Oct 31, 2026
Merged

kvlonge merged 3 commits into
mainfrom
docs/readme-sqlbuild-layout

Conversation

@kvlonge

@kvlonge kvlonge commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

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

  • SQLBuild's README layout, opening on speed: "The fastest SQL linter.", then "50× faster than sqruff. Lint 10,000 SQL files in under a second." with a Benchmarks link next to it.
  • Concise copy, a Website · Get started · Docs · Benchmarks row, the install line and the existing check/fix demo.
  • A compact speed table using the figures on the published benchmarks page (10,282 Snowflake files, 4 CPUs, no cache). The caveats stay on that page, which the README links.
  • Correctness and safety benefits, a short custom Python Rule taken from the docs, quick start, integrations and docs links. The reference material moved to the docs.
  • Absolute image and link URLs, so the logo and demo also render on PyPI. No em dashes.

Verification

  • A fresh benchmark rerun on the same corpus reproduces the claim: sqlclean check 0.81 s (median of 3; every round under 1 s) against 39.97 s for sqruff (49×; the published figure is 51×).
  • Every link and image returns 200, and readme_renderer passes. A browser render shows the logo, headline, links and demo.
  • The public-repository hygiene check is clean.

Co-authored-by: Kevin Longe <kvlonge@gmail.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 31, 2026 •

Copy link
Copy Markdown

Deploying sqlclean with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8e2f216
Status: ✅  Deploy successful!
Preview URL: https://28a04db9.sqlclean.pages.dev
Branch Preview URL: https://docs-readme-sqlbuild-layout.sqlclean.pages.dev

View logs

ampagent and others added 2 commits October 31, 2026 05:33
Co-authored-by: Kevin Longe <kvlonge@gmail.com>
…arks

Co-authored-by: Kevin Longe <kvlonge@gmail.com>
@kvlonge
kvlonge merged commit a37459b into main Oct 31, 2026
14 checks passed
@kvlonge
kvlonge deleted the docs/readme-sqlbuild-layout branch October 31, 2026 05:56
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>

---------
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants