Skip to content

Contributing Guide

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

Prerequisites:

  • Node/npm or Bun, 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 (npm install && npm run docs:dev or bun install && bun run docs:dev).
  4. Edit MDX in docs/pages/... and keep examples aligned with the current released Rust SDK surface.
  5. Build check: npm run build (or bun run docs:build).
  6. Commit/push and open a PR.

Aim for concise, Rust-focused examples. Document real capability boundaries explicitly rather than leaving stale placeholders.