Skip to content

Contributing

This site is built with Astro Starlight and published to GitHub Pages at wraithbox.nl. Contributions are welcome: see CONTRIBUTING.md in the repository root.

Tools are pinned in .mise.toml. Run mise install once, then:

  • mise run doc:install: install the site dependencies (bun).
  • mise run doc:dev: start the live-reloading dev server.
  • mise run doc:build: build the static site into packages/wraithbox-doc/dist.
  • mise run doc:check: run the Astro type/content check.
  • mise run prose:lint and mise run prose:spell: check the writing with Vale and cspell.

Pages are in packages/wraithbox-doc/src/content/docs/, and static assets in packages/wraithbox-doc/public/.

Commit messages follow Conventional Commits. Use the language or component as the scope when relevant (docs(doc): ...). The full CI gate runs with mise run ci, and mise run doc:check plus mise run doc:build cover the docs site. Design changes start in the specifications under docs/spec/. See AGENTS.md at the repo root for the guidelines.