doc: Improve examples and generate documentation pages with typedoc support #111
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated TypeScript to version 5.7.2 for improved features and performance. - Ensured compatibility with existing TypeScript configuration. Signed-off-by: Greg Osuri <[email protected]>
- Installed TypeDoc to facilitate automatic generation of project documentation. - Updated package.json and package-lock.json to include TypeDoc as a development dependency. Signed-off-by: Greg Osuri <[email protected]>
- Implemented `checkEndpointHealth` function to demonstrate how to retrieve and log the health status of network endpoints. - Utilized `getEndpoints` and `getEndpointHealthStatus` to fetch and evaluate endpoint response times. - Included error handling to manage potential issues during the health check process. Signed-off-by: Greg Osuri <[email protected]>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #111 +/- ##
==========================================
- Coverage 70.13% 69.02% -1.12%
==========================================
Files 23 23
Lines 864 878 +14
Branches 224 228 +4
==========================================
Hits 606 606
- Misses 244 257 +13
- Partials 14 15 +1 ☔ View full report in Codecov by Sentry. |
- Added detailed description of the getAccount function. - Included a @throws clause to document potential error conditions. - Provided an example usage with error handling for better clarity. Signed-off-by: Greg Osuri <[email protected]>
- Added comprehensive comments to all type definitions in `src/sdl/types.ts`. - Improved clarity and understanding of v2 and v3 manifest structures. - Documented optional parameters and resource configurations for better developer guidance. - Ensured consistency in documentation style across all type definitions. Signed-off-by: Greg Osuri <[email protected]>
- Generated updated documentation using Typedoc - Ensured the latest changes are reflected in the docs - Updated the docs script to open the documentation automatically Signed-off-by: Greg Osuri <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.