docs: uv-first onboarding and SEO groundwork - #233
Merged
Conversation
The prerequisites now offer sqlc-bin (recommended) and the official sqlc installation as equal tabs, driver installs default to uv with a one-line pip fallback note, and the landing page's setup section is three short steps instead of a full sqlc.yaml listing.
- add a unique meta description to every page; they flow into the meta, Open Graph, Twitter, and schema.org tags - override hextra's opengraph partial: the theme emits og:description and og:type as multi-line attributes, which hugo --minify truncates to empty values on the published site - add a 1200x630 social preview card (og:image, twitter:card summary_large_image) and og:site_name via params.title - enable hextra's llms.txt and per-page raw-Markdown outputs - stop publishing empty /tags/ and /categories/ taxonomy pages
Contributor
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
The new raw-Markdown outputs gave GitHub Pages' Jekyll pass .md files to render, and its output at the extensionless /docs/getting-started URL shadowed the redirect to the real page. With .nojekyll in the publish root, Pages serves the Hugo output as-is and extensionless directory URLs redirect to their trailing-slash form again.
The CNAME ships from static/ so the cleaning deploy never unsets the custom domain. With the site now at an origin root, robots.txt is actually read by crawlers, so it advertises the sitemap. baseURL, the PR-preview baseURL, and every README link move to the new domain.
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.
Defaults the docs to uv with sqlc-bin as the recommended install, streamlines the landing page setup section, and lays SEO groundwork: per-page meta descriptions, a fix for the Open Graph tags broken by minification, a social preview card, and llms.txt.