Skip to content

Contributing Guide

Thanks for your interest in contributing! For this Rust docs site:

Prerequisites:

  • bun (for docs scripts), git/GitHub, Markdown-friendly editor.

Workflow:

  1. Fork/clone the repo containing circles-rs-book.
  2. Create a branch for your change.
  3. Install deps and run the dev server (bun install, bun run docs:dev).
  4. Edit MDX in docs/pages/... following existing structure and placeholders (mark runner-required flows).
  5. Build check: bun run docs:build.
  6. Commit/push and open a PR.

Aim for concise, Rust-focused examples; keep runner-dependent sections as placeholders until writes are supported.