Skip to content

docs: add local setup guide and ignore mdbook build output - #303

Open
aaniya22 wants to merge 1 commit into
mohu-org:mainfrom
aaniya22:docs/local-setup-guide-283
Open

docs: add local setup guide and ignore mdbook build output#303
aaniya22 wants to merge 1 commit into
mohu-org:mainfrom
aaniya22:docs/local-setup-guide-283

Conversation

@aaniya22

Copy link
Copy Markdown

What

Adds a local development setup guide to CONTRIBUTING.md, plus a small drive-by fix to .gitignore.

Why

New contributors need a verified, working set of steps to get a local dev environment running. Closes #283 (double-check this issue number before posting).

How

  • Every command in the guide was run against a fresh checkout before being documented — the setup commands and mdbook build docs all produce clean, real output.
  • While verifying the mdbook preview instructions, mdbook build generated a docs/book/ output directory and some auto-generated stub chapter files (blank placeholders for SUMMARY.md entries with no content yet). These were removed from the working tree and are not part of this PR.
  • Added docs/book/ to .gitignore so future contributors following this guide don't accidentally commit build output.

Checklist

  • cargo test --workspace passes
  • cargo clippy --workspace -- -D warnings passes
  • cargo fmt --all applied
  • CHANGELOG.md updated (if user-facing change) — not applicable, docs-only change
  • Benchmarks added or updated (if performance-sensitive path) — not applicable

@aaniya22
aaniya22 requested a review from Bbn08 as a code owner July 15, 2026 12:36
@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@aaniya22, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 2 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 9c142bbb-b80f-4422-88c6-766cf7c34d5c

📥 Commits

Reviewing files that changed from the base of the PR and between 3c07775 and d7908ff.

📒 Files selected for processing (2)
  • .gitignore
  • CONTRIBUTING.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

PR Check Summary

Item Value
Branch docs/local-setup-guide-283
Changed crates none
Files changed 2

CI will run: build, test, clippy, fmt, cargo-deny, DCO, semver.
Reviewer assigned from CODEOWNERS.

Signed-off-by: Aaniya <aaniyaatomar@gmail.com>
@aaniya22
aaniya22 force-pushed the docs/local-setup-guide-283 branch from f1975d6 to d7908ff Compare July 15, 2026 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve project documentation for easier local setup

1 participant