docs(generator): update latest generator documentation #3783
Conversation
asyncapi-bot
requested review from
quetzalliwrites,
TRohit20 and
asyncapi-bot-eve
as code owners
WalkthroughThe documentation has been updated to simplify the command usage details for the AsyncAPI CLI. In the usage file, extensive command syntax details have been removed in favor of a concise header directing users to the official documentation. In the versioning file, the command example now specifies the HTML 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 (2)
markdown/docs/tools/generator/usage.md (1)
31-37: Retained Detailed Global Template Installation Guidance
The code snippet showing global installation for templates (lines 31-37) still provides valuable context. The coexistence of both the legacy (html-template version 0.16.0) and new command examples (later in the document) might prompt users to double-check which command applies to their use case. Consider a clarifying note if needed.🧰 Tools
🪛 LanguageTool
[style] ~31-~31: Consider placing the discourse marker ‘first’ at the beginning of the sentence for more clarity.
Context: ...tps://www.asyncapi.com/docs/tools/cli). The generator first tries to locate the template in local d...(SENT_START_FIRST_PREMIUM)
markdown/docs/tools/generator/versioning.md (1)
24-25: Nitpick: Punctuation Enhancement for Improved Readability
There is a minor punctuation suggestion on the note (lines 24-25). In the sentence, consider inserting a comma after the--use-new-generatorflag to read:"...and to use the latest version, you may need to pass the
--use-new-generatorflag, for more details ..."
This slight adjustment could enhance clarity as highlighted by static analysis.🧰 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 (2)
markdown/docs/tools/generator/usage.md(1 hunks)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 (2)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
🔇 Additional comments (3)
markdown/docs/tools/generator/usage.md (2)
10-14: Simplified CLI Command Header for Clarity
The updated header (lines 11-14) now succinctly directs users to the official AsyncAPI CLI documentation for complete usage details. This effectively removes redundant command syntax details from the docs and improves maintainability, ensuring users refer to the most up-to-date information.
41-44: Updated Short Syntax Command Example
The command example under "The shortest possible syntax" now explicitly uses the versioned template (@3.0.0) along with the--use-new-generatorflag. This update aligns with the latest generator updates and provides a clear example.markdown/docs/tools/generator/versioning.md (1)
20-22: Enhanced Command Example with Version and Flag
The updated command in the code snippet (lines 20-22) now clearly specifies both the template version and the--use-new-generatorflag. This explicitness minimizes ambiguity around which generator version is being used and ensures proper compatibility as documented.
Updated generator documentation is available and this PR introduces update to generator folder on the website
Summary by CodeRabbit