docs: rebuild the README around the landing page's identity - #98
Merged
Conversation
The README opened with a badge wall and a wall of prose, then mixed user and contributor material together. It now leads with the mark, the landing page's own tagline, and the workflow diagram, then walks the same path the site does: the last-mile problem, install, quickstart, the three build steps, and what you get. Real artifacts throughout — the GGSQL and dashboard YAML samples are lifted from examples/simple_dbt rather than invented, and the CLI table lists the nine commands the CLI actually registers. Adds a Status table that separates what ships today from what is planned, so the README does not inherit forward-looking claims. Moves Task/CI and docs-site development into a collapsed Contributing block so the top of the page stays aimed at someone deciding whether to try glyf. Assets are referenced by absolute raw URLs because this README is also the PyPI long description; verified it renders through readme_renderer with every image, table, and collapsible section intact. The hero diagram is wrapped on an opaque card so it stays legible in GitHub's dark theme, where its near-black text would otherwise disappear. Drops the Codecov badge, which resolves to "unknown" from both the shields and codecov endpoints.
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
1 participant
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.
The README opened with a badge wall and a block of prose, then mixed user-facing and contributor material together. It now leads with the mark, the landing page's own tagline, and the workflow diagram, then walks the same path the site does: the last-mile problem → install → quickstart → the three build steps → what you get.
What changed
examples/simple_dbt, not invented. The CLI table lists the nine commands the CLI actually registers.uvstays the headline; the script, Homebrew, pipx/pip and offline routes move into a collapsed block.unknownfrom both the shields and codecov endpoints, so it was showing a grey badge rather than a number.Notes
README.mdis also the PyPI long description (readme = "README.md"inpyproject.toml), so every link and image uses an absolute URL — relative paths would break on PyPI. Verified withreadme_renderer: renders cleanly with all 7 images, both collapsible sections, and all 4 tables intact..github/assets/readme-hero.svgwrapsdocs-site/static/img/glyf-hero-diagram-v3.svgon an opaque card. The original has a transparent background and#111111text, which disappears in GitHub's dark theme. The sdist uses an explicit include allowlist, so the new asset does not ship in the package.Images resolve against
main, so they will render once this is merged.