docs(generator): update latest generator documentation #4109
Conversation
asyncapi-bot
requested review from
TRohit20,
asyncapi-bot-eve and
quetzalliwrites
as code owners
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughA new tutorial document was added to guide users through building a Java MQTT client template using AsyncAPI, complete with project setup, code generation, Gradle configuration, and reusable template components. Additionally, the Python template tutorial’s title was clarified, and minor formatting was adjusted. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant AsyncAPI Generator
participant Template (index.js)
participant TopicFunction Component
participant Output Java Client
User->>AsyncAPI Generator: Run generator with AsyncAPI doc
AsyncAPI Generator->>Template (index.js): Pass asyncapi, params
Template (index.js)->>TopicFunction Component: Generate topic methods from channels
TopicFunction Component-->>Template (index.js): Return Java methods for each topic
Template (index.js)->>Output Java Client: Assemble Client.java with topic methods
Output Java Client-->>User: Generated Java client code
Poem
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4109 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
asyncapi-bot
deleted the
update-generator-docs-9f19c224c4dab71b357cc9124c8d597c4075fbe3
branch
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
markdown/docs/tools/generator/generator-template.md (2)
12-15: Clarify the “React template” bullet in a Python tutorialThis Python-focused tutorial still mentions “You’ll create a React template,” which may confuse readers. Consider rephrasing to emphasize that you’re using the React render engine of the AsyncAPI generator to build a Python template (e.g., “You’ll create a template using the generator-react-sdk engine to produce Python code”).
🧰 Tools
🪛 LanguageTool
[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... the MQTT client in this project. - You'll create a React template that will us...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
374-374: Remove invalid comment from JSON snippetJSON does not support
#comments. The snippet inpackage.jsonshowing# ...(redacted for brevity)may confuse readers. Either remove the comment or convert it into a note outside the code block.markdown/docs/tools/generator/generator-template-java.md (3)
30-30: Unify “sub-directories” spellingThe term “sub-directories” is typically spelled “subdirectories” in technical docs. Consider updating to improve consistency.
🧰 Tools
🪛 LanguageTool
[misspelling] ~30-~30: This word is normally spelled as one.
Context: ...hat is done, you should create some new sub-directories to begin building your Java client. 1...(EN_COMPOUNDS_SUB_DIRECTORIES)
39-46: Add language identifiers to directory-tree code blocksSeveral code fences showing the project directory structure lack a language specifier. For better syntax highlighting and linting, consider using
text orbash for these tree diagrams:bashAlso applies to: 181-193, 431-437
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
40-40: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
233-233: Remove trailing period in headingThe heading
### 4. Output Java template code.should omit the period for consistency with other headings (e.g.,
### 3. Test the Java Client).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
233-233: Trailing punctuation in heading
Punctuation: '.'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
markdown/docs/tools/generator/generator-template-java.md(1 hunks)markdown/docs/tools/generator/generator-template.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
markdown/docs/tools/generator/generator-template-java.md
[misspelling] ~30-~30: This word is normally spelled as one.
Context: ...hat is done, you should create some new sub-directories to begin building your Java client. 1...
(EN_COMPOUNDS_SUB_DIRECTORIES)
[style] ~34-~34: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...plate#background-context) into it. 4. Create a new file named package.json in yo...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~234-~234: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... index.js and copy the content below so your file looks like the code snippet b...
(COMMA_COMPOUND_SENTENCE_2)
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/tools/generator/generator-template-java.md
13-13: Bare URL used
null
(MD034, no-bare-urls)
14-14: Bare URL used
null
(MD034, no-bare-urls)
40-40: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
103-103: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
136-136: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
182-182: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
233-233: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
433-433: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 180000ms (2)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
🔇 Additional comments (1)
markdown/docs/tools/generator/generator-template.md (1)
2-2: Title Clarification ApprovedThe updated title
"Creating a template - Python"clearly specifies the language focus for this tutorial and aligns with best practices for language-specific documentation.
|
|
||
| ## Prerequisites | ||
|
|
||
| To run it, ensure you have Java JDK 8 or higher, Gradle, and the AsyncAPI generator. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Include AsyncAPI CLI in Prerequisites
You list Java JDK and Gradle but omit the AsyncAPI CLI, which is required to run asyncapi generate. Please add “AsyncAPI CLI” (or “AsyncAPI generator CLI”) to the prerequisites for completeness.
Updated generator documentation is available and this PR introduces update to generator folder on the website
Summary by CodeRabbit