bmc4j docs

Documentation website for bmc4j — bounded model checking verification for Kotlin and Java.

Built with Astro + Starlight, a markdown-first documentation framework. Deployed to GitHub Pages at https://bmc4j.github.io/docs/.

Status: scaffold only. Content is intentionally empty for now — there is a single placeholder page so the site builds. Real documentation will be added later.

Stack

• Astro 6.4.5
• @astrojs/starlight 0.40.0
• Node >= 22.12.0

Dependency versions are pinned in package.json.

Run locally

npm install      # install dependencies
npm run dev      # start the dev server (http://localhost:4321/docs)
npm run build    # produce a production build in dist/
npm run preview  # preview the production build locally

Where docs go

Documentation pages live in src/content/docs/ as .md / .mdx files. Each file becomes a page; front matter (title, description, ...) controls its metadata. The sidebar is configured in astro.config.mjs.

Deployment

Pushing to main triggers .github/workflows/deploy.yml, which builds the Astro site and publishes it to GitHub Pages (source: GitHub Actions). The site / base in astro.config.mjs are set for a project page served from /docs.

Future work

Real documentation could be sourced by syncing the markdown under the docs/ directory of the bmc4j/bmc4j repo into src/content/docs/ as a build step. Not implemented yet.