Deploy the documentation site
This docs site is an Astro + Starlight project in docs-site/. It deploys to GitHub Pages at https://Qentora.github.io/quoptuna via a GitHub Actions workflow.
Build locally
Section titled “Build locally”cd docs-sitenpm installnpm run buildStatic output lands in docs-site/dist/.
Preview locally
Section titled “Preview locally”cd docs-sitenpm run devThe dev server defaults to http://localhost:4321.
Deploy flow
Section titled “Deploy flow”A GitHub Actions workflow triggers on pushes to main that touch docs-site/**. The workflow runs npm ci && npm run build and publishes dist/ with actions/deploy-pages.
Because this is a project page (not a user/org root page), astro.config.mjs sets:
| Setting | Value | Overridable via |
|---|---|---|
site | https://Qentora.github.io | DOCS_SITE env |
base | /quoptuna | DOCS_BASE env |
The env overrides exist for PR preview builds.
Pull request previews
Section titled “Pull request previews”Pull requests get an automatic preview deployment. The preview URL is posted as a comment on the PR, so reviewers can see the rendered docs before merge.