feat(docs): Astro Starlight site for GitHub Pages#24
Merged
Conversation
Add site/ with Astro 5 + Starlight for end-user docs. 10 pages covering overview, getting started, Claude Code agent, all CLI commands, and the Brief JSON schema. GitHub Actions workflow deploys to GitHub Pages on push to main paths: site/** or the workflow file itself. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Summary
site/— a full Astro 5 + Starlight docs site for end-user documentationCLAUDE.md,lib/,agents/skywatch.md).github/workflows/docs.yml) builds and deploys to GitHub Pages on push tomain(paths:site/**or the workflow file)site/node_modules/,site/dist/, andsite/.astro/added to.gitignorelib/,spec/,Gemfile,skywatch.gemspec) untouchedPages (10 total)
src/content/docs/index.mdsrc/content/docs/getting-started.mdsrc/content/docs/claude-agent.mdsrc/content/docs/cli/brief.mdsrc/content/docs/cli/weather.mdsrc/content/docs/cli/nimbus.mdsrc/content/docs/cli/mayday.mdsrc/content/docs/cli/radar.mdsrc/content/docs/cli/agent.mdsrc/content/docs/reference/brief-shape.mdLocal build verified
Before the first deploy — manual step required
Enable GitHub Pages in the repo settings before the workflow can deploy:
Repo Settings → Pages → Build and deployment → Source → GitHub Actions
Once that is set, any push to
mainthat touchessite/**will trigger the build + deploy job.Test plan
docs.ymlworkflow triggers automaticallyhttps://jayrav13.github.io/skywatch/to confirm the site is live🤖 Generated with Claude Code