docs(generator): update latest generator documentation #4025
Conversation
asyncapi-bot
requested review from
TRohit20,
asyncapi-bot-eve and
quetzalliwrites
as code owners
WalkthroughThe changes update the Nunjucks render engine documentation. The text now includes a comma before a configuration link, updates a relative link to an absolute URL for the official AsyncAPI nunjucks-filters, and adds a note indicating that Nunjucks filters are deprecated, with a reference to the AsyncAPI generator release notes for version 2.6.0. No public entity declarations were altered. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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. 🪧 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. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4025 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 21 21
Lines 667 667
Branches 113 113
=========================================
Hits 667 667 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![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 (1)
markdown/docs/tools/generator/nunjucks-render-engine.md (1)
78-78: Grammar Improvement in Filter Configuration DescriptionThe sentence "To learn how to add such filters to configuration, read more about the configuration file" is almost clear but could benefit from improved grammatical clarity. Adding the definite article “the” before "configuration" can enhance readability. Consider updating it to:
"To learn how to add such filters to the configuration, read more about the configuration file".-To learn how to add such filters to configuration, [read more about the configuration file](configuration-file) +To learn how to add such filters to the configuration, [read more about the configuration file](configuration-file)🧰 Tools
🪛 LanguageTool
[uncategorized] ~78-~78: You might be missing the article “the” here.
Context: ...ary in the template configuration underfiltersproperty. To learn how to add s...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/tools/generator/nunjucks-render-engine.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
markdown/docs/tools/generator/nunjucks-render-engine.md
[uncategorized] ~78-~78: You might be missing the article “the” here.
Context: ...ary in the template configuration under filters property. To learn how to add s...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ 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 (2)
markdown/docs/tools/generator/nunjucks-render-engine.md (2)
81-81: Improved Link to Official Nunjucks FiltersThe link for the official AsyncAPI nunjucks-filters has been updated from a relative to an absolute URL. This change improves accessibility and clarity for users by linking directly to the repository location.
83-83: Clear Deprecation Notice for Nunjucks FiltersThe newly added note clearly informs users about the deprecation of nunjucks-filters and advises a migration to the React renderer, also providing a reference to the release notes for version 2.6.0. This is informative and aligns well with the current deprecation strategy.
asyncapi-bot
deleted the
update-generator-docs-0050d4f7aaf1dd329c2d975a05d0a1ef5a0859c1
branch
Updated generator documentation is available and this PR introduces update to generator folder on the website
Summary by CodeRabbit