docs(generator): update latest generator documentation

[asyncapi-bot]

Updated generator documentation is available and this PR introduces update to generator folder on the website

Summary by CodeRabbit

• Documentation
  • Installation Guide: Streamlined instructions now direct users to the official AsyncAPI CLI installation guide with an added note on CI/CD usage.
  • Usage Instructions: Simplified command usage details into a concise signature and provided a reminder about npm package installation for templates.
  • Versioning Info: Updated the HTML generation command to include a specific version and a new flag, clarifying the approach for accessing the latest generator.

[coderabbitai]

Walkthrough

This pull request updates the AsyncAPI CLI generator documentation. The installation guide and usage documentation have been streamlined by removing detailed, multi-OS instructions and extensive command examples. Instead, users are now directed to the official AsyncAPI CLI documentation, with added notes for CI/CD pipelines and npm package templates. Additionally, the HTML generation command in the versioning document is updated to include a specific template version and a new flag to access the latest generator.

Changes

File(s)	Summary
markdown/docs/tools/generator/installation-guide.md markdown/docs/tools/generator/usage.md	Removed detailed installation instructions and usage examples; replaced with concise references to the official AsyncAPI CLI guide and added notes on CI/CD and npm.
markdown/docs/tools/generator/versioning.md	Updated the HTML generation command to specify @asyncapi/html-template@3.0.0 and include the --use-new-generator flag; added an informational note on versioning.

Possibly related PRs

• docs(cli): update latest cli documentation #3713: Updates the HTML generation command to include version-specific flags, aligning with the modifications in this PR.
• docs(cli): update latest cli documentation #3391: Restructures documentation for the CLI by streamlining installation and usage guides, directly relating to these documentation updates.
• docs(generator): update latest generator documentation #3613: Focuses on revising the installation instructions for the AsyncAPI CLI, which complements the changes made in the installation-guide.

Suggested labels

autoapproved, autoupdate

Suggested reviewers

• quetzalliwrites
• VaishnaviNandakumar
• J0SAL
• BhaswatiRoy
• TRohit20
• asyncapi-bot-eve

Poem

I'm a rabbit with hops so light,
Skipping through docs with all my might,
Less text, more focus, a clear new way,
Guiding users each passing day.
With ASCII whiskers and joyful cheer,
I celebrate these changes, dear!

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9687130 and 5d2af89.

📒 Files selected for processing (3)

• markdown/docs/tools/generator/installation-guide.md (1 hunks)
• markdown/docs/tools/generator/usage.md (1 hunks)
• markdown/docs/tools/generator/versioning.md (1 hunks)

⏰ 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 (4)

markdown/docs/tools/generator/installation-guide.md (1)

28-28: Streamlined AsyncAPI CLI reference.
The updated paragraph now directs users to the official AsyncAPI CLI installation guide, which aligns perfectly with the objective of streamlining documentation. This change reduces duplicate instructions and minimizes maintenance overhead.

markdown/docs/tools/generator/usage.md (1)

11-14: Concise command signature header.
The new header now clearly showcases the command syntax (asyncapi generate fromTemplate ASYNCAPI TEMPLATE) and immediately directs users to comprehensive details on the official AsyncAPI CLI documentation, enhancing clarity and reducing redundancy.

markdown/docs/tools/generator/versioning.md (2)

21-21: Updated HTML generation command.
The HTML generation command now specifies the template version and includes the --use-new-generator flag. This update improves clarity on version compatibility and ensures that users are aware of the latest generator requirements.

---

24-25: Helpful generator version note.
The added informational note explains the need for the --use-new-generator flag in environments with multiple generator versions and provides a direct link to more detailed usage instructions. This information is concise and useful for guiding users.

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify]

✅ Deploy Preview for asyncapi-website ready!

Name	Link
🔨 Latest commit	f5c8956
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/67c7dbfdcaebbf0008355515
😎 Deploy Preview	https://deploy-preview-3785--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (da6e5b4) to head (f5c8956).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #3785   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           21        21           
  Lines          667       667           
  Branches       113       113           
=========================================
  Hits           667       667           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[akshatnema]

/rtm