Parent PRD
What to build
Add a GitHub Actions workflow that builds the Starlight docs site and deploys it to GitHub Pages automatically when changes are pushed to main.
End-to-end, this means:
- Create
.github/workflows/deploy_docs.yml with:
- Trigger on push to
main with path filter: packages/docs/**
- Manual
workflow_dispatch trigger for ad-hoc deploys
- Concurrency group to cancel in-progress deploys
- Build job: checkout, pnpm setup, install,
pnpm docs:build
- Deploy job: upload
packages/docs/dist/ as pages artifact, deploy via actions/deploy-pages
- Appropriate permissions (
pages: write, id-token: write, contents: read)
- Enable GitHub Pages in repo settings with source set to "GitHub Actions" (manual step, document in the PR)
- Verify the workflow runs successfully and the site is accessible at
https://aws.github.io/graph-explorer/
Acceptance criteria
Blocked by
User stories addressed
- User story 6 (auto-deploy on merge)
- User story 8 (canonical documentation URL)
Parent PRD
What to build
Add a GitHub Actions workflow that builds the Starlight docs site and deploys it to GitHub Pages automatically when changes are pushed to
main.End-to-end, this means:
.github/workflows/deploy_docs.ymlwith:mainwith path filter:packages/docs/**workflow_dispatchtrigger for ad-hoc deployspnpm docs:buildpackages/docs/dist/as pages artifact, deploy viaactions/deploy-pagespages: write,id-token: write,contents: read)https://aws.github.io/graph-explorer/Acceptance criteria
.github/workflows/deploy_docs.ymlexists and is validmainonly whenpackages/docs/**files changeworkflow_dispatchhttps://aws.github.io/graph-explorer/after first deployBlocked by
User stories addressed