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: automate api docs generation #21

Merged
merged 3 commits into from
Aug 11, 2021
Merged

docs: automate api docs generation #21

merged 3 commits into from
Aug 11, 2021

Conversation

KhudaDad414
Copy link
Member

Description

now we are using jsdoc2md to automate API generation from JSDOCs.

Related issue(s)
Fixes #14

derberg
derberg reviewed Aug 11, 2021
View reviewed changes
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

Shouldn't only the Optimizer class be exposed in the API?

package.json Outdated Show resolved Hide resolved
magicmatatjahu
magicmatatjahu reviewed Aug 11, 2021
View reviewed changes
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@sonarcloud
Copy link

sonarcloud bot commented Aug 11, 2021

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@magicmatatjahu
Copy link
Member

@KhudaDad414 You should also try to run generate:assets locally. If it works after changes, I will accept PR, please only let me know, if everything is good :)

@derberg derberg changed the title docs: automatic api generation implemented. docs: automate api docs generation Aug 11, 2021
@KhudaDad414
Copy link
Member Author

@KhudaDad414 You should also try to run generate:assets locally. If it works after changes, I will accept PR, please only let me know, if everything is good :)

It works like a charm! :)

magicmatatjahu
magicmatatjahu approved these changes Aug 11, 2021
View reviewed changes
Copy link
Member

@magicmatatjahu magicmatatjahu left a comment

Choose a reason for hiding this comment

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

LGTM! @derberg Do you want to add something more?

@derberg
Copy link
Member

derberg commented Aug 11, 2021

go ahead and hit that merge button! good express work 👏🏼

@magicmatatjahu magicmatatjahu merged commit d22ae06 into asyncapi:master Aug 11, 2021
@aayushmau5 aayushmau5 mentioned this pull request Aug 12, 2021
Closed
@KhudaDad414 KhudaDad414 deleted the feat_jsdoc2md branch August 12, 2021 13:10
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 0.0.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@magicmatatjahu magicmatatjahu magicmatatjahu approved these changes

@derberg derberg Awaiting requested review from derberg

Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Implement API generation
4 participants
@KhudaDad414 @magicmatatjahu @derberg @asyncapi-bot