Contributing Guide
Thanks for your interest in contributing! For this Rust docs site:
Prerequisites:
- Node/npm or Bun, git/GitHub, Markdown-friendly editor.
Workflow:
- Fork/clone the repo containing
circles-rs-book. - Create a branch for your change.
- Install deps and run the dev server (
npm install && npm run docs:devorbun install && bun run docs:dev). - Edit MDX in
docs/pages/...and keep examples aligned with the current released Rust SDK surface. - Build check:
npm run build(orbun run docs:build). - Commit/push and open a PR.
Aim for concise, Rust-focused examples. Document real capability boundaries explicitly rather than leaving stale placeholders.