ReadMe Sync Runbook

ScheduleSpark docs are authored in docs/readme and published to ReadMe with rdme@v10.

Required ReadMe Setup

1. Create the ReadMe project.
2. Add docs.schedulespark.com as the custom domain.
3. Create the Guide categories Getting Started, Packages, Frontend Setup, and Operations.
4. Add the GitHub secret README_API_KEY.

Local Validation

Run a dry run before merging docs changes. Export README_API_KEY first, or replace the variable with your ReadMe API key:

npx rdme@v10 docs upload docs/readme --dry-run --key="$README_API_KEY"

Production Publishing

The GitHub Actions workflow publishes on pushes to beta when files under docs/readme/** or .github/workflows/readme-docs.yml change.