Skip to content

Docs/add no std usage examples - #32

Merged
AteebNoOne merged 3 commits into
iTeebot:mainfrom
anidroid1184:docs/add-no-std-usage-examples
Jul 24, 2026
Merged

Docs/add no std usage examples#32
AteebNoOne merged 3 commits into
iTeebot:mainfrom
anidroid1184:docs/add-no-std-usage-examples

Conversation

@anidroid1184

@anidroid1184 anidroid1184 commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Contribution Checklist

  • ⭐ I have starred the repository
  • 🔀 I have forked the repository and created a new branch for my changes
  • 📖 I have read the CONTRIBUTING.md guide

Description

Add no_std usage example to docs/

Related Issue

Closes #24

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 📝 Documentation update
  • 🔧 Refactor (code change that neither fixes a bug nor adds a feature)
  • ⚡ Performance improvement
  • ✅ Test addition or update
  • 🏗️ CI/CD or build system change

Checklist

  • I have added or updated tests that prove my fix is effective or my feature works
  • cargo clippy --all-targets -- -D warnings passes with no warnings
  • cargo fmt --check passes with no formatting issues
  • cargo test --all-targets passes
  • cargo test --doc passes
  • I have updated documentation as needed (rustdoc, README, etc.)
  • I have updated the changelog (if applicable)
  • My changes do not introduce any new unsafe code (or it is properly justified and documented)

Additional Notes

Summary by CodeRabbit

  • Documentation
    • Added guidance for using the library in no_std + alloc environments.
    • Documented configuration requirements, supported APIs, limitations, examples, and build verification steps.
    • Added links to architecture documentation covering no_std usage and WASM support.

@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

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

Next review available in: 47 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: e6222b81-aba8-420c-ac4e-16d9362746c9

📥 Commits

Reviewing files that changed from the base of the PR and between 931ca17 and a4212fd.

📒 Files selected for processing (1)
  • docs/architecture/no_std_usage.md
📝 Walkthrough

Walkthrough

Adds a no_std + alloc usage guide covering configuration, examples, API availability, limitations, and verification commands. The README now links to the no_std and WASM architecture documentation.

Changes

no_std Documentation

Layer / File(s) Summary
no_std setup and parsing example
docs/no_std_usage.md
Documents feature configuration, allocator and panic-handler requirements, plus parsing, attribute access, and serialization examples.
API availability and limitations
docs/no_std_usage.md
Lists supported capabilities, contrasts std-only APIs, and records known no_std limitations.
Verification guidance and documentation links
docs/no_std_usage.md, README.md
Adds native, WASM, and embedded verification commands and links the no_std and WASM documentation from the README.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested labels: enhancement

Suggested reviewers: ateebnoone

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly reflects the docs-focused no_std usage update and README link changes.
Linked Issues check ✅ Passed The docs cover Cargo.toml flags, a minimal no_std example, limitations, README linking, and verification steps.
Out of Scope Changes check ✅ Passed The changes stay within documentation updates for no_std support and add no unrelated code.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 154-157: Update README.md lines 154-157 to link to
docs/no_std_usage.md, and update docs/no_std_usage.md lines 10-13 to reference
architecture/wasm.md; keep both documents under their current docs locations and
ensure all documentation paths resolve consistently.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 9627ab75-3c56-4989-94f3-b2f551eed3a8

📥 Commits

Reviewing files that changed from the base of the PR and between 3b834cb and 931ca17.

📒 Files selected for processing (2)
  • README.md
  • docs/no_std_usage.md

Comment thread README.md
@AteebNoOne
AteebNoOne self-requested a review July 24, 2026 22:13
@AteebNoOne
AteebNoOne merged commit ef658ce into iTeebot:main Jul 24, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Good First Issue]: Add no_std usage example to docs/

2 participants