fix: correct template generation process steps

[KunalNasa]

This PR corrects the template generation process steps and the definition of asyncapi variable.

Fixes #1400

Summary by CodeRabbit

• Documentation
  • Updated the template documentation to enhance clarity on default parameter usage in the template generation system. The updated descriptions now provide a clearer distinction between similar references, reducing ambiguity and helping users better understand how their templates are configured.

[changeset-bot]

⚠️ No Changeset found

Latest commit: dfd4657

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The documentation in the generator’s template file has been updated to clarify the definition of the asyncapi variable. The change now specifies that asyncapi is an instance of AsyncAPIDocument (instead of the original document) and distinguishes it from originalAsyncAPI within the Template Context. These updates address discrepancies noted in the linked documentation bug report.

Changes

File(s)	Change Summary
apps/generator/docs/template.md	Updated the description of the asyncapi variable to state it is an instance of AsyncAPIDocument and differentiated it from originalAsyncAPI in the Template Context.

Assessment against linked issues

Objective	Addressed	Explanation
Fix incorrect description of asyncapi variable [#1400]	✅
Clarify the distinction between asyncapi and originalAsyncAPI in the Template Context [#1400]	✅

Poem

I'm a hopping rabbit full of cheer,
Celebrating docs that are now crystal clear.
AsyncAPI’s now defined with care,
Distinct and precise in the Template air.
Hoppy updates, making our journey smooth and dear!
🐇🎉

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.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f02dc4d and dfd4657.

📒 Files selected for processing (1)

• apps/generator/docs/template.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Test generator as dependency with Node 20
• GitHub Check: Test generator as dependency with Node 18

🔇 Additional comments (2)

apps/generator/docs/template.md (2)

26-26: Clarified asyncapi variable representation.
The updated description now makes it explicit that asyncapi is an instance of AsyncAPIDocument injected by default into your template. This removes any ambiguity regarding its type when compared with the original document.

---

28-28: Enhanced distinction between asyncapi and originalAsyncAPI.
This change clarifies that both asyncapi and originalAsyncAPI are passed to the Template Context, making the separation between the modified instance and the original document explicit. This aligns well with the PR objectives by addressing the documentation discrepancies.

---

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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud