Skip to content

Update Documentation for crates and examples - #32

Merged
ghimiresdp merged 4 commits into
mainfrom
fix/docs
Jul 26, 2026
Merged

Update Documentation for crates and examples#32
ghimiresdp merged 4 commits into
mainfrom
fix/docs

Conversation

@ghimiresdp

@ghimiresdp ghimiresdp commented Jul 26, 2026

Copy link
Copy Markdown
Owner

Description

Please describe the changes in this PR. Explain the problem you're solving or the feature you're adding.

  • Added/Updated documentation for different crates
  • Updated contributing guidelines to be more clear and concise
  • Updated example crates dependency version and alternatives for different use case.

Related Issue

Closes #


Type of Change

  • Bug fix (fixes an issue without changing existing functionality)
  • New feature (adds new functionality)
  • Breaking change (changes that would cause existing functionality to work differently)
  • Documentation update
  • Performance improvement
  • Refactoring (no behavior change)
  • Dependencies update

Checklist

  • My code follows the project style guidelines (ran cargo fmt) — if applicable
  • I've linted my code (ran cargo clippy) — if applicable
  • I've written and run tests (cargo test passes) — if applicable
  • I've added tests for new functionality or bug fixes — if applicable
  • I've updated documentation (README, code comments, etc.) — if applicable
  • I've updated the changelog/release notes — if applicable
  • My commits follow the Conventional Commits specification
  • I've reviewed my own code before submitting

Breaking Changes

If this introduces breaking changes, please describe:

  • What changed and why
  • How users should migrate their code

Performance Impact

  • No performance impact
  • Performance improved (describe improvements)
  • Performance regressed (describe regression and mitigation)

Details:


Screenshots / Demo

@ghimiresdp ghimiresdp changed the title Fix/docs Update Documentation for crates and examples Jul 26, 2026
@ghimiresdp
ghimiresdp merged commit 2040746 into main Jul 26, 2026
4 checks passed
@ghimiresdp
ghimiresdp deleted the fix/docs branch July 26, 2026 08:15
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.

1 participant