docs(generator): update latest generator documentation #3573
Conversation
WalkthroughThe pull request introduces documentation updates for the AsyncAPI Generator library. The changes primarily focus on the API documentation for the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3573 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 19 19
Lines 668 668
=========================================
Hits 668 668 ☔ View full report in Codecov by Sentry. |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3573--asyncapi-website.netlify.app/ |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
markdown/docs/tools/generator/api.md (2)
42-42: Add migration guidance for deprecated method.The deprecation notice for
generateFromStringshould include information about the recommended alternative method that developers should use instead.Consider adding a note like this:
- ~~[.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString) ⇒ `Promise.<(TemplateRenderResult|undefined)>`~~ + ~~[.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString) ⇒ `Promise.<(TemplateRenderResult|undefined)>`~~ **Deprecated:** Use `generate(asyncapiString, parseOptions)` instead.🧰 Tools
🪛 Markdownlint (0.37.0)
42-42: Expected: 4; Actual: 8
Unordered list indentation(MD007, ul-indent)
42-44: Fix markdown list indentation.The unordered list items are indented with 8 spaces, but markdown style guide recommends 4 spaces.
Apply this formatting change:
- * ~~[.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString) ⇒ `Promise.<(TemplateRenderResult|undefined)>`~~ - * [.generateFromURL(asyncapiURL)](#Generator+generateFromURL) ⇒ `Promise.<(TemplateRenderResult|undefined)>` - * [.generateFromFile(asyncapiFile)](#Generator+generateFromFile) ⇒ `Promise.<(TemplateRenderResult|undefined)>` + * ~~[.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString) ⇒ `Promise.<(TemplateRenderResult|undefined)>`~~ + * [.generateFromURL(asyncapiURL)](#Generator+generateFromURL) ⇒ `Promise.<(TemplateRenderResult|undefined)>` + * [.generateFromFile(asyncapiFile)](#Generator+generateFromFile) ⇒ `Promise.<(TemplateRenderResult|undefined)>`🧰 Tools
🪛 Markdownlint (0.37.0)
42-42: Expected: 4; Actual: 8
Unordered list indentation(MD007, ul-indent)
43-43: Expected: 4; Actual: 8
Unordered list indentation(MD007, ul-indent)
44-44: Expected: 4; Actual: 8
Unordered list indentation(MD007, ul-indent)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
markdown/docs/tools/generator/api.md(1 hunks)markdown/docs/tools/generator/installation-guide.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- markdown/docs/tools/generator/installation-guide.md
🧰 Additional context used
🪛 Markdownlint (0.37.0)
markdown/docs/tools/generator/api.md
42-42: Expected: 4; Actual: 8
Unordered list indentation
(MD007, ul-indent)
43-43: Expected: 4; Actual: 8
Unordered list indentation
(MD007, ul-indent)
44-44: Expected: 4; Actual: 8
Unordered list indentation
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 180000ms (2)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
| * [.generateFromURL(asyncapiURL)](#Generator+generateFromURL) ⇒ `Promise.<(TemplateRenderResult|undefined)>` | ||
| * [.generateFromFile(asyncapiFile)](#Generator+generateFromFile) ⇒ `Promise.<(TemplateRenderResult|undefined)>` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Document cases where methods return undefined.
The return types for generateFromURL and generateFromFile now include undefined as a possible return value, but there's no documentation explaining under what conditions this occurs.
Consider adding documentation like this:
- [.generateFromURL(asyncapiURL)](#Generator+generateFromURL) ⇒ `Promise.<(TemplateRenderResult|undefined)>`
+ [.generateFromURL(asyncapiURL)](#Generator+generateFromURL) ⇒ `Promise.<(TemplateRenderResult|undefined)>` - Returns undefined when [specify condition]
- [.generateFromFile(asyncapiFile)](#Generator+generateFromFile) ⇒ `Promise.<(TemplateRenderResult|undefined)>`
+ [.generateFromFile(asyncapiFile)](#Generator+generateFromFile) ⇒ `Promise.<(TemplateRenderResult|undefined)>` - Returns undefined when [specify condition]Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 Markdownlint (0.37.0)
43-43: Expected: 4; Actual: 8
Unordered list indentation
(MD007, ul-indent)
44-44: Expected: 4; Actual: 8
Unordered list indentation
(MD007, ul-indent)
Updated generator documentation is available and this PR introduces update to generator folder on the website
Summary by CodeRabbit
generateFromStringmethodgenerateFromString,generateFromURL, andgenerateFromFilemethods