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
  • Improved documentation clarity by clearly distinguishing between the original API document and its instance used during template generation, enhancing understanding of the template context.

[coderabbitai]

Walkthrough

This pull request updates the markdown template used in the documentation generator. It specifies that the asyncapi variable is an instance of AsyncAPIDocument and adds a new variable, originalAsyncAPI, to the template context. These changes clarify the distinction between the injected and the original AsyncAPI document without altering the overall generation flow.

Changes

File	Change Summary
markdown/.../template.md	Clarified asyncapi as an instance of AsyncAPIDocument and added originalAsyncAPI to the context.

Possibly related PRs

• asyncapi/website#3339: Addresses similar corrections by distinguishing between asyncapi and originalAsyncAPI for consistency in terminology.

Suggested labels

autoapproved, autoupdate

Suggested reviewers

• quetzalliwrites
• TRohit20
• Aahil13
• VaishnaviNandakumar
• asyncapi-bot-eve

Poem

In a garden of code, I hop with delight,
Clarifying variables in the soft moonlight.
asyncapi now gleams as its true self defined,
With originalAsyncAPI gracefully aligned.
Code carrots abound—oh, what a joyous night!
🥕✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 plan to trigger planning for file edits and PR creation.
• @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	c48f03a
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/67fd1952831aec0008e23335
😎 Deploy Preview	https://deploy-preview-4042--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 (17089d9) to head (c48f03a).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #4042   +/-   ##
=========================================
  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.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

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

28-28: Inclusion of originalAsyncAPI in Template Context
The addition of originalAsyncAPI to the Template Context makes it clear that both the processed and the original AsyncAPI document are available. Consider adding a brief note or example that highlights when to use originalAsyncAPI versus asyncapi for better user guidance.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 17089d9 and c48f03a.

📒 Files selected for processing (1)

• markdown/docs/tools/generator/template.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 (1)

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

26-26: Clarified asyncapi Variable Type
The update now clearly specifies that asyncapi is an instance of AsyncAPIDocument, which enhances clarity for template authors regarding the data they are working with.