docs(generator): update latest generator documentation #3339
Conversation
asyncapi-bot
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
WalkthroughThis pull request introduces modifications to the documentation of the AsyncAPI generator process. It corrects a typographical error in the variable name Changes
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
CodeRabbit Configuration File (
|
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
asyncapi-bot
requested review from
devilkiller-ag,
sambhavgupta0705,
BhaswatiRoy,
J0SAL,
TRohit20 and
VaishnaviNandakumar
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3339 +/- ##
=======================================
Coverage 49.14% 49.14%
=======================================
Files 21 21
Lines 647 647
=======================================
Hits 318 318
Misses 329 329 ☔ View full report in Codecov by Sentry. |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3339--asyncapi-website.netlify.app/ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
markdown/docs/tools/generator/asyncapi-document.md (2)
44-44: Improve formatting and clarity of the asyncapi explanation.The explanation is technically accurate but needs minor formatting improvements.
Consider this revision for better readability and consistent formatting:
- - The `asyncapi` (`AsyncAPIDocument`) which is an object with a set of helper functions, that comes as a result of the `Parser` manipulating the `originalAyncAPI` .The `asyncapi` functions make it easier to access the contents of AsyncAPI documents in your templates. + - The `asyncapi` (`AsyncAPIDocument`) which is an object with a set of helper functions that comes as a result of the parser manipulating the `originalAsyncAPI`. The `asyncapi` functions make it easier to access the contents of AsyncAPI documents in your templates.
Line range hint
1-100: LGTM! Consider enhancing the mermaid diagram.The documentation effectively explains the AsyncAPI document generation process and the relationship between
asyncapiandoriginalAsyncAPI. The content is technically accurate and well-structured.Consider adding tooltips to the mermaid diagram boxes to provide quick explanations when hovering over components. This can be done by adding quotes after the node text:
graph LR - A[Template Context] + A[Template Context]("Contains asyncapi and originalAsyncAPI") - B{Generator} + B{Generator}("Processes AsyncAPI document and coordinates generation")
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- markdown/docs/tools/generator/asyncapi-document.md (1 hunks)
- markdown/docs/tools/generator/hooks.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint
markdown/docs/tools/generator/hooks.md
13-13: null
Spaces inside code span elements(MD038, no-space-in-code)
asyncapi-bot
deleted the
update-generator-docs-261b66eacff9fa77dcfaf62487d6dfe9a09423c0
branch
Updated generator documentation is available and this PR introduces update to generator folder on the website
Summary by CodeRabbit