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
  • Updated documentation to reflect React as the only supported render engine for AsyncAPI Generator.
  • Removed Nunjucks-related documentation and migration guides.
  • Simplified configuration examples by removing deprecated renderer and filters properties.
  • Clarified template development guidance to focus on React-based templating.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[netlify]

✅ Deploy Preview for asyncapi-website ready!

Name	Link
🔨 Latest commit	c8bdccf
🔍 Latest deploy log	https://app.netlify.com/projects/asyncapi-website/deploys/694a9649450b660008721720
😎 Deploy Preview	https://deploy-preview-4719--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 project configuration.

[coderabbitai]

Walkthrough

This PR systematically removes Nunjucks render engine support from AsyncAPI Generator documentation, consolidating the tooling to exclusively support the React render engine. Configuration examples, migration guides, and feature documentation are updated to reflect this change.

Changes

Cohort / File(s)	Summary
Deprecated Engine Documentation Removed markdown/docs/tools/generator/migration-cli.md, markdown/docs/tools/generator/migration-nunjucks-react.md, markdown/docs/tools/generator/nunjucks-render-engine.md	Entire files deleted: migration guide from ag CLI to AsyncAPI CLI, migration guide from Nunjucks to React templating, and Nunjucks render engine reference documentation.
Configuration Examples Updated markdown/docs/tools/generator/configuration-file.md, markdown/docs/tools/generator/generator-template.md, markdown/docs/tools/generator/generator-template-java.md, markdown/docs/tools/generator/template-development.md	Removed renderer and filters properties from generator configuration examples in package.json and .ageneratorrc code samples.
Core Generator Documentation Simplified markdown/docs/tools/generator/index.md, markdown/docs/tools/generator/react-render-engine.md, markdown/docs/tools/generator/template.md	Updated to describe React as the only supported render engine, removing multi-engine conditional logic and Nunjucks render path references. React engine now explicitly stated as exclusive.
Feature Documentation Refined markdown/docs/tools/generator/asyncapi-document.md, markdown/docs/tools/generator/file-templates.md, markdown/docs/tools/generator/typescript-support.md	Removed Nunjucks-specific sections and references; consolidated guidance to React render engine and React-based hooks for TypeScript support.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Changes follow a consistent, homogeneous pattern of removing Nunjucks references across documentation
• Documentation-only modifications with no code logic or runtime behavior impact
• May warrant brief verification that:
  • File removals (migration-cli.md, migration-nunjucks-react.md, nunjucks-render-engine.md) are intentional
  • Rewrites in file-templates.md and react-render-engine.md accurately reflect the React-only architecture

Possibly related PRs

• docs(generator): update latest generator documentation #3875: Modifies generator configuration examples and conflicts on renderer field removal in package.json/generator-template.md
• docs(generator): update latest generator documentation #4025: Directly overlaps on Nunjucks render engine documentation modifications
• docs(generator): update latest generator documentation #4042: Overlaps on template.md and Template Context/variables documentation

Suggested labels

autoapproved, autoupdate

Suggested reviewers

• quetzalliwrites
• TRohit20
• thulieblack
• derberg
• asyncapi-bot-eve

Poem

🐰 Nunjucks bows, React takes the stage—
No more dual paths, a single engage!
Migration guides fade, configuration grows lean,
AsyncAPI's render engine: React, clean and keen! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs(generator): update latest generator documentation' accurately reflects the primary change: updating generator documentation across multiple markdown files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch update-generator-docs-39249d25a1ea47a6ade034e07a7c382c5bf12db8

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 83e282a and 6a5e856.

📒 Files selected for processing (13)

• markdown/docs/tools/generator/asyncapi-document.md (1 hunks)
• markdown/docs/tools/generator/configuration-file.md (0 hunks)
• markdown/docs/tools/generator/file-templates.md (1 hunks)
• markdown/docs/tools/generator/generator-template-java.md (0 hunks)
• markdown/docs/tools/generator/generator-template.md (1 hunks)
• markdown/docs/tools/generator/index.md (1 hunks)
• markdown/docs/tools/generator/migration-cli.md (0 hunks)
• markdown/docs/tools/generator/migration-nunjucks-react.md (0 hunks)
• markdown/docs/tools/generator/nunjucks-render-engine.md (0 hunks)
• markdown/docs/tools/generator/react-render-engine.md (2 hunks)
• markdown/docs/tools/generator/template-development.md (2 hunks)
• markdown/docs/tools/generator/template.md (1 hunks)
• markdown/docs/tools/generator/typescript-support.md (1 hunks)

💤 Files with no reviewable changes (5)

• markdown/docs/tools/generator/nunjucks-render-engine.md
• markdown/docs/tools/generator/generator-template-java.md
• markdown/docs/tools/generator/migration-cli.md
• markdown/docs/tools/generator/configuration-file.md
• markdown/docs/tools/generator/migration-nunjucks-react.md

🧰 Additional context used

🧠 Learnings (4)

📓 Common learnings

Learnt from: anshgoyalevil
Repo: asyncapi/website PR: 3950
File: scripts/utils/check-locales.ts:122-129
Timestamp: 2025-04-20T16:05:16.482Z
Learning: In the AsyncAPI website project, Next.js throws errors at runtime when locale files are missing, making additional validation for missing files unnecessary in the check-locales script.

📚 Learning: 2025-01-18T08:44:43.614Z

Learnt from: akshatnema
Repo: asyncapi/website PR: 3423
File: tests/index.test.js:2-7
Timestamp: 2025-01-18T08:44:43.614Z
Learning: In the AsyncAPI website project, JavaScript test files must include the .ts extension when importing TypeScript files (e.g., `require('../scripts/build-rss.ts')`). This is a project-specific requirement enforced by the linting rules and build setup, even though it differs from typical Node.js behavior.

Applied to files:

• markdown/docs/tools/generator/typescript-support.md

📚 Learning: 2025-01-18T08:44:43.614Z

Learnt from: akshatnema
Repo: asyncapi/website PR: 3423
File: tests/index.test.js:2-7
Timestamp: 2025-01-18T08:44:43.614Z
Learning: In the AsyncAPI website project, JavaScript test files must include the .ts extension when importing TypeScript files (e.g., `require('../scripts/build-rss.ts')`). This is enforced by the project's configuration which uses `moduleResolution: "bundler"` in tsconfig.json and TypeScript-aware ESLint plugins. The .ts extensions are required even though the files are imported using CommonJS require statements.

Applied to files:

• markdown/docs/tools/generator/typescript-support.md

📚 Learning: 2025-01-18T08:44:43.614Z

Learnt from: akshatnema
Repo: asyncapi/website PR: 3423
File: tests/index.test.js:2-7
Timestamp: 2025-01-18T08:44:43.614Z
Learning: In JavaScript test files within the AsyncAPI website project, TypeScript file imports must include the .ts extension to avoid lint errors, even though the files being imported are JavaScript files.

Applied to files:

• markdown/docs/tools/generator/typescript-support.md

🪛 LanguageTool

markdown/docs/tools/generator/file-templates.md

[style] ~8-~8: To reduce wordiness, try specifying a number or using “many” or “numerous” instead.
Context: ... templates or when you need to generate a large number of files with varying content. ### Exampl...

(LARGE_NUMBER_OF)

⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)

• GitHub Check: Automerge PR autoapproved by a bot
• GitHub Check: Redirect rules - asyncapi-website
• GitHub Check: Header rules - asyncapi-website
• GitHub Check: Pages changed - asyncapi-website
• GitHub Check: Lighthouse CI
• GitHub Check: cypress-run

🔇 Additional comments (8)

markdown/docs/tools/generator/typescript-support.md (1)

6-6: Verify incomplete migration of "filter" reference in React-only context.

Line 9 still mentions "filter" alongside "hook," but the PR objective removes Nunjucks support (where filters were a concept). In a React-only workflow, templates use only hooks. Please clarify whether "filter" is still relevant or should be removed entirely to align with the single-engine consolidation.

Also applies to: 9-9

markdown/docs/tools/generator/asyncapi-document.md (1)

24-24: LGTM!

The update correctly reflects React as the sole render engine, with proper link reference to the react-render-engine documentation. The change maintains clarity and supports the consolidated workflow.

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

48-50: LGTM!

The changes clearly establish React as the exclusive render engine used by AsyncAPI Generator. The wording is precise and the flow of the generation process is well-documented. No references to alternative engines remain.

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

459-460: LGTM!

The note correctly updates to direct users to the React render engine documentation, aligning with the consolidated single-engine approach. The context within the tutorial section makes sense, and all code examples throughout already use React.

markdown/docs/tools/generator/file-templates.md (1)

6-8: LGTM!

The section now clearly focuses on the React render engine with a straightforward description of returning an array of File components. The examples that follow are accurate and well-demonstrate the React-based approach to multi-file generation.

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

27-28: LGTM!

The update clearly establishes React as the single Render Engine through explicit statement and link reference. The generation process steps now reflect a consolidated single-engine workflow while maintaining comprehensive output examples.

markdown/docs/tools/generator/react-render-engine.md (1)

6-13: LGTM!

The update clearly establishes React as the only supported render engine with strong assertion language. The revised bullet points appropriately describe React's advantages, with generalized wording that removes Nunjucks-specific references while maintaining technical accuracy.

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

43-43: LGTM!

The update correctly reflects the simplified generator configuration where the renderer field is no longer needed. Removing the explicit renderer: "react" aligns with the single-engine consolidation and simplifies the required configuration for new templates. All subsequent examples maintain consistency with this approach.

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (ced4c27) to head (c8bdccf).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #4719   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           22        22           
  Lines          798       798           
  Branches       146       146           
=========================================
  Hits           798       798           

☔ 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.

[asyncapi-bot]

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🔴 Performance	37
🟢 Accessibility	98
🟢 Best practices	92
🟢 SEO	100
🔴 PWA	33

Lighthouse ran on https://deploy-preview-4719--asyncapi-website.netlify.app/

[thulieblack]

/rtm

[thulieblack]

/rtm