Skip to content

Add Blume docs site, changelog from GitHub releases, and a tighter README - #3

Merged
ethndotsh merged 1 commit into
masterfrom
claude/switchboard-docs-deploy-7c0308
Jul 16, 2026
Merged

ethndotsh merged 1 commit into
masterfrom
claude/switchboard-docs-deploy-7c0308

Conversation

@ethndotsh

Copy link
Copy Markdown
Owner

What changed

  • Docs site under 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.
  • Changelog sourced from GitHub releases (github-releases content source) — publishing a release adds an entry at /changelog. Docs and Changelog render as top-level header tabs.
  • README rewritten to be concise, pointing into the docs; the architecture diagram moved to docs/public/ and the new wordmark logo renders in both GitHub color modes via <picture>.
  • CHANGELOG.md deleted — GitHub releases are now the single source of truth.
  • Adapter-specific sections carry "Caddy only" / "Standalone only" badges, styled via theme.css.
  • Includes the documentation-writer and Blume agent skills plus a launch.json for the docs dev server.

Reviewer notes

  • docs/pnpm-workspace.yaml sets shamefullyHoist: true to work around Blume 1.0.4 resolving its own deps through the symlinked package path under pnpm's strict layout (builds otherwise fail with Cannot find module 'astro/config').
  • blume build and blume validate pass 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.
  • To run locally: cd docs && pnpm install && pnpm dev. Deploy is static: build blume build, output dist, root docs, Node ≥ 22.12; set deployment.site once a domain exists.

@ethndotsh
ethndotsh merged commit bef7f0f into master Jul 16, 2026
4 checks passed
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