docs(generator): update latest generator documentation #3780
Conversation
asyncapi-bot
requested review from
TRohit20,
asyncapi-bot-eve and
quetzalliwrites
as code owners
WalkthroughThe documentation has been updated to revise the AsyncAPI CLI command for generating HTML. The command now explicitly uses the template version 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. |
![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
🧹 Nitpick comments (1)
markdown/docs/tools/generator/versioning.md (1)
24-25: Punctuation improvement in informational note.
The informational note would read more naturally with a comma after "For more details". Consider updating the line to:> AsyncAPI CLI has multiple versions of the generator, and to use the latest version, you may need to pass the `--use-new-generator` flag. For more details, you can also check [asyncapi generate fromTemplate ASYNCAPI TEMPLATE](https://www.asyncapi.com/docs/tools/cli/usage#asyncapi-generate-fromtemplate-asyncapi-template)-... flag. For more details you can also check [asyncapi generate fromTemplate ASYNCAPI TEMPLATE](... +... flag. For more details, you can also check [asyncapi generate fromTemplate ASYNCAPI TEMPLATE](...🧰 Tools
🪛 LanguageTool
[uncategorized] ~24-~24: Possible missing comma found.
Context: ...he--use-new-generatorflag. For more details you can also check [asyncapi generate f...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/tools/generator/versioning.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
markdown/docs/tools/generator/versioning.md
[uncategorized] ~24-~24: Possible missing comma found.
Context: ...he --use-new-generator flag. For more details you can also check [asyncapi generate f...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 180000ms (5)
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
🔇 Additional comments (1)
markdown/docs/tools/generator/versioning.md (1)
21-21: Update generator command with explicit version and flag.
The updated command clearly specifies the HTML template version (@3.0.0) and adds the--use-new-generatorflag, which aligns with the PR objectives and improves clarity for users.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3780 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 21 21
Lines 667 667
Branches 113 113
=========================================
Hits 667 667 ☔ View full report in Codecov by Sentry. |
akshatnema
deleted the
update-generator-docs-6b95fe67d06aa24c572a266e2744d7b146d8149d
branch
Updated generator documentation is available and this PR introduces update to generator folder on the website
Summary by CodeRabbit