Skip to content

readme: open with the logo, headline, links and a recorded demo - #148

Merged
kvlonge merged 2 commits into
mainfrom
docs/readme-landing
Nov 7, 2026
Merged

kvlonge merged 2 commits into
mainfrom
docs/readme-landing

Conversation

@kvlonge

@kvlonge kvlonge commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Docs-only change: README.md, images under .github/, and the recording scripts that produce the demo. No engine, converter or website page changes.

  • Logo: a centred light/dark <picture> using absolute raw.githubusercontent.com URLs. The new .github/sqlquack-logo-{light,dark}.png are 584×128 lockups of the existing duck (from website/public/assets/icon.png) with the wordmark in Space Grotesk Bold, the same face as sqlstack.io and the site header. Below it: by SQLStack.
  • Headline: "Run warehouse SQL locally. Verified results, or a clear no." in bold, centred.
  • Links: Website · Docs · Playground · Quickstart, all checked to return 200 on sqlquack.io.
  • Pitch and demo: a short pitch, then .github/demos/check-convert.gif, recorded with VHS from a real run of the sqlquack 0.2.0 binary built at main. It shows check reporting SQ0203 on a QUALIFY without a window function, convert returning DuckDB SQL, and convert refusing HASH with SQ0008. The tape, setup and scripts are in website/recordings/, mirroring SQLClean, so the GIF can be re-recorded with ./record.sh check-convert.
  • Quick start: build from source, clearly marked. The sqlquack package on PyPI is a 0.0.1 name reservation that does not contain the compiler, so pip install sqlquack is not yet a real install.
  • The rest: the existing technical sections stay, lightly tightened and regrouped. "What works today" now describes parsing, checking and translation separately and states no figures. Sessions, policy, exit status, census, index, Python, evidence and development are unchanged in substance.

The README images point at main, so they load once this merges.

Checks: hygiene scan clean, and the Website workflow runs because website/recordings/ changed.

Also: the social preview image is renamed to website/public/assets/og-sqlquack-v2.png, and every og:image and twitter:image (home page, playground, astro.config.mjs) points at https://sqlquack.io/assets/og-sqlquack-v2.png. The old file is removed. Unfurlers had cached the old card by URL. The site build and link check pass locally.

The README now opens like the other SQLStack products: a light and dark
logo with the wordmark in Space Grotesk Bold, the headline and tagline,
links to the website, docs, playground and quickstart, a short pitch and
a GIF of a real sqlquack check and convert run.

The quick start builds from source and says so, because the sqlquack
package on PyPI is still a name reservation. The technical sections
stay, tightened, with parsing, checking and translation described
separately.

The GIF is rendered with VHS from the tape in website/recordings, as
SQLClean records its demo.
Link unfurlers cache images by URL, so the warehouse SQL card kept
showing the old preview. Rename it to og-sqlquack-v2.png and point every
og:image and twitter:image at the new URL.
@kvlonge
kvlonge merged commit 33b47cf into main Nov 7, 2026
2 checks passed
@kvlonge
kvlonge deleted the docs/readme-landing branch November 9, 2026 21:31

This branch was previously deployed

1 inactive deployment
github-pages — 33b47cf5 Deployed Nov 7, 2026 by kvlonge via Deploy to GitHub Pages #173
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.

1 participant