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

chore(website): improved api docs #1421

Merged
merged 6 commits into from
Jun 26, 2023

Conversation

jonaslagoni
Copy link
Member

@jonaslagoni jonaslagoni commented Jun 24, 2023

Description
This PR adds improved API docs and exposes them on the website and remove the old API.md file.

Check it out here: https://deploy-preview-1421--modelina.netlify.app/docs/api

Related issue(s)
Fixes #106

@netlify
Copy link

netlify bot commented Jun 24, 2023

Deploy Preview for modelina ready!

Name Link
🔨 Latest commit 2665759
🔍 Latest deploy log https://app.netlify.com/sites/modelina/deploys/64977854970ee5000830313f
😎 Deploy Preview https://deploy-preview-1421--modelina.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@sonarcloud
Copy link

sonarcloud bot commented Jun 24, 2023

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
1.9% 1.9% Duplication

@coveralls
Copy link

coveralls commented Jun 24, 2023

Pull Request Test Coverage Report for Build 5366659978

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 92.192%

Totals Coverage Status
Change from base Build 5364611854: 0.0%
Covered Lines: 5259
Relevant Lines: 5562

💛 - Coveralls

@jonaslagoni jonaslagoni merged commit b0f8839 into asyncapi:master Jun 26, 2023
@jonaslagoni jonaslagoni deleted the improved_api_docs branch June 26, 2023 19:47
@jonaslagoni jonaslagoni restored the improved_api_docs branch June 26, 2023 19:53
jonaslagoni added a commit to jonaslagoni/generator-model-sdk that referenced this pull request Jun 26, 2023
jonaslagoni added a commit that referenced this pull request Jun 26, 2023
Revert "chore(website): improved api docs (#1421)"

This reverts commit b0f8839.
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 1.8.7 🎉

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.

Interfaces are not being documented via JSdoc
3 participants