Deployment

This page documents the docs pipeline contract for publishing rsspot-sdk docs to GitHub Pages.

Local Docs Validation

npx sparkify doctor
npx sparkify dev

When production build dependencies are healthy:

npx sparkify build --site https://sparkaiur.github.io --base /rsspot-sdk

GitHub Workflow Contract

• CI validation: .github/workflows/docs-ci.yml
• Pages publish: .github/workflows/docs-pages.yml
• Reusable action: uses: SparkAIUR/sparkify@v1

docs-pages.yml behavior:

1. Build job checks out repo and runs Sparkify action
2. Build uploads Pages artifact
3. Deploy job publishes artifact with actions/deploy-pages

Verification Checklist

1. Confirm latest docs-pages run succeeded
2. Open homepage and one nested route
3. Verify search and sidebar navigation
4. Verify llms copy widget appears on docs pages
5. Confirm llms.txt and llms-full.txt are reachable