Skip to content

docs: add JSDoc pages to README.md #3204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 3, 2025
Merged

docs: add JSDoc pages to README.md #3204

merged 1 commit into from
Jul 3, 2025

Conversation

ivaylonikolov7
Copy link
Contributor

Description:
Adds JSDoc documentation to the README.md

Related issue(s):
#3190

Notes for reviewer:

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

Signed-off-by: Ivaylo Nikolov <ivaylo.nikolov@limechain.tech>
@lfdt-bot
Copy link
Contributor

lfdt-bot commented Jul 1, 2025

🎉 Snyk checks have passed. No issues have been found so far.

security/snyk check is complete. No issues have been found. (View Details)

@ivaylonikolov7 ivaylonikolov7 changed the title docs: add jsdoc docs: add JSDoc pages to README.md Jul 1, 2025
Copy link

codecov bot commented Jul 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ivaylonikolov7 ivaylonikolov7 merged commit 7d15f2b into main Jul 3, 2025
17 of 18 checks passed
@ivaylonikolov7 ivaylonikolov7 deleted the feat/update-docs branch July 3, 2025 10:44
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.

3 participants