Skip to content

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.

Terminal window
cd docs-site
npm install
npm run build

Static output lands in docs-site/dist/.

Terminal window
cd docs-site
npm run dev

The dev server defaults to http://localhost:4321.

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:

SettingValueOverridable via
sitehttps://Qentora.github.ioDOCS_SITE env
base/quoptunaDOCS_BASE env

The env overrides exist for PR preview builds.

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.