Skip to content
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

feat(examples): improve documentation #117

Merged
merged 6 commits into from
Jan 20, 2025
Merged

Conversation

baktun14
Copy link
Contributor

  • Simplified the command to run an example
  • Improved the examples readme with more information on setting up and running the examples
  • Added dotenv to load the mnemonic in an unrecorded env file instead of txt file

@codecov-commenter
Copy link

codecov-commenter commented Jan 17, 2025

Codecov Report

Attention: Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.

Project coverage is 70.13%. Comparing base (8be7bc2) to head (659bd17).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
src/certificates/certificate-manager/index.ts 0.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #117   +/-   ##
=======================================
  Coverage   70.13%   70.13%           
=======================================
  Files          23       23           
  Lines         864      864           
  Branches      224      221    -3     
=======================================
  Hits          606      606           
  Misses        244      244           
  Partials       14       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@baktun14 baktun14 requested a review from ygrishajev January 17, 2025 16:54
@baktun14 baktun14 requested a review from stalniy January 17, 2025 20:06
@baktun14 baktun14 merged commit 16cb3c3 into main Jan 20, 2025
3 checks passed
@baktun14 baktun14 deleted the features/improve-documentation branch January 20, 2025 17:12
github-actions bot pushed a commit that referenced this pull request Jan 20, 2025
## [0.11.0](v0.10.1...v0.11.0) (2025-01-20)

### Features

* Add JSDoc comments with examples to ValidationError and SdlValidationError classes ([c7788e5](c7788e5))
* Add JSDoc comments with examples to ValidationError and SdlValidationError classes ([916cf7c](916cf7c))
* **examples:** improve documentation ([#117](#117)) ([16cb3c3](16cb3c3))
Copy link

🎉 This PR is included in version 0.11.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants