Repository navigation
Add Blume docs site, changelog from GitHub releases, and a tighter README - #3
Merged
Merged
Conversation
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.
What changed
docs/, built with Blume (pnpm). 17 pages organized Diátaxis-style: a quickstart tutorial, concepts (architecture, bundles/channels/revisions, security & reliability), guides (writing rules, testing, replay, deploying, Caddy, standalone/embedded, registries), and a full reference (CLI, switchboard.yaml, Caddyfile directives, SDK, tests.yaml schema, bundle format, observability) verified against the Go source.github-releasescontent source) — publishing a release adds an entry at/changelog. Docs and Changelog render as top-level header tabs.docs/public/and the new wordmark logo renders in both GitHub color modes via<picture>.theme.css.documentation-writerand Blume agent skills plus alaunch.jsonfor the docs dev server.Reviewer notes
docs/pnpm-workspace.yamlsetsshamefullyHoist: trueto work around Blume 1.0.4 resolving its own deps through the symlinked package path under pnpm's strict layout (builds otherwise fail withCannot find module 'astro/config').blume buildandblume validatepass locally; the only validate warnings are relative links inside the published v0.1.0 GitHub release body (../../examples/...), fixable by editing the release to absolute URLs.cd docs && pnpm install && pnpm dev. Deploy is static: buildblume build, outputdist, rootdocs, Node ≥ 22.12; setdeployment.siteonce a domain exists.