update docs 📝

[aniketmaurya]

Changes

Fixes # (issue)

Type of change

• 📚 Documentation Update
• 🧪 Tests Cases
• 🐞 Bug fix (non-breaking change which fixes an issue)
• 🔬 New feature (non-breaking change which adds functionality)
• 🚨 Breaking change (fix or feature that would cause existing functionality to not work as expected)
• 📝 This change requires a documentation update

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• Did you update CHANGELOG (docs/CHANGELOG.md) in case of a major change?

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[codecov]

Codecov Report

Merging #175 (f79e631) into main (84fb252) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #175   +/-   ##
=======================================
  Coverage   94.99%   94.99%           
=======================================
  Files          69       69           
  Lines        2117     2117           
=======================================
  Hits         2011     2011           
  Misses        106      106           

Flag	Coverage Δ
unittests	94.99% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 84fb252...f79e631. Read the comment docs.