Contributing Guide
Thanks for your interest in contributing! For this Rust docs site:
Prerequisites:
- bun (for docs scripts), 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 (
bun install,bun run docs:dev). - Edit MDX in
docs/pages/...following existing structure and placeholders (mark runner-required flows). - Build check:
bun run docs:build. - Commit/push and open a PR.
Aim for concise, Rust-focused examples; keep runner-dependent sections as placeholders until writes are supported.