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.

Sign up for GitHub

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

Jump to bottom

docs(parser): add api docs #2685

Merged
merged 5 commits into from
Jun 26, 2024
Merged

docs(parser): add api docs #2685

merged 5 commits into from
Jun 26, 2024

Conversation

am29d
Copy link
Contributor

@am29d am29d commented Jun 21, 2024

Summary

This PR extends API docs for parser including schemas, envelopes and types. I have added typedoc-plugin-zod so the rendering is of the zod schema is more readable, an example for before and after is down below.

Changes

Please provide a summary of what's being changed

  • added schemas, envelopes and types to typedoc configuration for parser
  • added comments for schemas and types with examples and external links
  • added typedoc-plugin-zod for better rendering of the zod schema in api docs
  • fix few api doc links on other modules

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: closes #2640

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@am29d am29d requested review from a team as code owners June 21, 2024 15:28
@boring-cyborg boring-cyborg bot added automation This item relates to automation dependencies Changes that touch dependencies, e.g. Dependabot, etc. documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) labels Jun 21, 2024
@pull-request-size pull-request-size bot added the size/XXL PRs with 1K+ LOC, largely documentation related label Jun 21, 2024
@am29d am29d force-pushed the docs/parser-api-docs branch from ce0393f to 864116b Compare June 21, 2024 15:37
@boring-cyborg boring-cyborg bot added the parser This item relates to the Parser Utility label Jun 21, 2024
@pull-request-size pull-request-size bot added size/S PR between 10-29 LOC and removed size/XXL PRs with 1K+ LOC, largely documentation related labels Jun 21, 2024
@boring-cyborg boring-cyborg bot added the tests PRs that add or change tests label Jun 21, 2024
@pull-request-size pull-request-size bot added size/XXL PRs with 1K+ LOC, largely documentation related and removed size/S PR between 10-29 LOC labels Jun 21, 2024
@am29d am29d marked this pull request as draft June 21, 2024 15:46
@am29d
Copy link
Contributor Author

am29d commented Jun 21, 2024

Waiting for #2665 to be merged, so I can rebase.

@dreamorosi
Copy link
Contributor

Ok - I'll be ready for review on Monday end of morning at the latest!

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@am29d am29d marked this pull request as ready for review June 26, 2024 08:54
@am29d am29d requested a review from dreamorosi June 26, 2024 08:54
dreamorosi
dreamorosi approved these changes Jun 26, 2024
View reviewed changes
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing work on this PR, really stepped up the quality of the API docs!

@dreamorosi dreamorosi merged commit 64115c6 into main Jun 26, 2024
12 checks passed
@dreamorosi dreamorosi deleted the docs/parser-api-docs branch June 26, 2024 09:05
@am29d am29d restored the docs/parser-api-docs branch August 7, 2024 08:21
@am29d am29d deleted the docs/parser-api-docs branch August 7, 2024 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dreamorosi dreamorosi dreamorosi approved these changes

Assignees

@am29d am29d

Labels
automation This item relates to automation dependencies Changes that touch dependencies, e.g. Dependabot, etc. documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) parser This item relates to the Parser Utility size/XXL PRs with 1K+ LOC, largely documentation related tests PRs that add or change tests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: cleanup api docs for parser utility
2 participants
@am29d @dreamorosi