fixed the archived/deprecated Glee framework #4559 #4560
Conversation
hk2166
requested review from
Mayaleeeee,
TRohit20,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg,
sambhavgupta0705 and
thulieblack
as code owners
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
We require all PRs to follow Conventional Commits specification. |
WalkthroughThe tutorial content is completely rewritten to guide users through code generation using the AsyncAPI Generator tool instead of the Glee framework. Prerequisites, installation steps, commands, templates, and examples are updated to reflect the official generator's approach and ecosystem. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4560--asyncapi-website.netlify.app/ |
![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
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (1)
markdown/docs/tutorials/generate-code.md(1 hunks)
⏰ 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). (1)
- GitHub Check: Lighthouse CI
🔇 Additional comments (8)
markdown/docs/tutorials/generate-code.md (8)
2-5: Frontmatter looks good.The metadata is clear and well-suited for documentation navigation.
7-9: Clear and focused introduction.The heading and opening sentence effectively communicate the tutorial's purpose.
11-15: Verify version requirements and clarify the AsyncAPI document prerequisite.The specific Node.js and npm version numbers should be confirmed as accurate minimum requirements. Additionally, "An AsyncAPI document" is vague—consider linking to example documents or documentation that explains what constitutes a valid AsyncAPI document for users unfamiliar with the specification.
17-23: Installation instructions are clear and correct.The npm install command is properly formatted and the global installation approach is appropriate for a getting-started tutorial.
25-37: Basic usage section is well-structured and provides a concrete example.The command syntax and example are clear. Users should be able to run the HTML template example without issue.
39-49: Template section provides good overview with link to complete repository.The selection of templates shown is representative, and the link to the template repository appropriately directs users to the authoritative source for all available options.
51-63: Template Options section effectively teaches discovery of template configuration.The
ag help <template>command is a practical way for users to learn about template-specific options without needing to consult external documentation first.
65-73: Next Steps section provides good progression paths.The references to further documentation, template development guide, and community are appropriate for continuing users' learning journey.
| ## Prerequisites | ||
|
|
||
| Glee is often used with the [AsyncAPI CLI](/tools/cli) for a better development experience. | ||
| - Node.js v20.12.0 or later | ||
| - npm v10.5.0 or later | ||
| - An AsyncAPI document |
There was a problem hiding this comment.
🧩 Analysis chain
Verify external links and Node.js/npm version requirements.
This tutorial references several external URLs and specific software versions that should be validated:
External Links to verify:
- Line 49: GitHub AsyncAPI Generator templates link
- Line 67, 72: Template Development Guide link
- Line 71: Main AsyncAPI Generator documentation link
- Line 73: AsyncAPI Community link
Version Requirements to verify:
- Line 13-14: Node.js v20.12.0 and npm v10.5.0—confirm these are accurate minimum versions (not overly restrictive) and match current @asyncapi/generator requirements
All links should be tested for validity and confirmed to lead to active, relevant documentation. Version numbers should be cross-referenced with the package's package.json or official documentation to ensure they reflect current requirements.
Also applies to: 39-49, 65-73
🏁 Script executed:
#!/bin/bash
# Description: Verify external links are reachable and check AsyncAPI Generator package requirements
# Check HTTP status of all external links
echo "=== Checking external links ==="
curl -s -o /dev/null -w "GitHub templates: %{http_code}\n" https://github.com/asyncapi/generator#templates
curl -s -o /dev/null -w "Template dev guide: %{http_code}\n" https://www.asyncapi.com/docs/tools/generator/template-development
curl -s -o /dev/null -w "Generator docs: %{http_code}\n" https://www.asyncapi.com/docs/tools/generator
curl -s -o /dev/null -w "Community: %{http_code}\n" https://www.asyncapi.com/community
# Check current version requirements from npm package
echo -e "\n=== AsyncAPI Generator package requirements ==="
npm view @asyncapi/generator engines --json 2>/dev/null || echo "Could not fetch package info"
# Check if package exists and get latest version
echo -e "\n=== Latest package info ==="
npm view @asyncapi/generator version 2>/dev/null || echo "Could not fetch version info"Length of output: 243
Update version requirements to match package minimums or clarify tested compatibility.
All external links validate successfully (HTTP 200). However, the tutorial specifies overly restrictive version requirements:
Current tutorial requirements:
- Node.js v20.12.0 or later
- npm v10.5.0 or later
Actual @asyncapi/generator requirements:
- Node.js >=18.12.0
- npm >=8.19.0
The tutorial versions are 2+ major versions higher than the package's documented minimum requirements. Consider either:
- Updating to the package minimums (v18.12.0 and v8.19.0) for broader compatibility, or
- If v20.12.0/v10.5.0 represent tested/recommended versions, clarify this in the tutorial text (e.g., "tested with" vs. "required")
🤖 Prompt for AI Agents
In markdown/docs/tutorials/generate-code.md around lines 11-15, the Node.js and
npm version requirements are stricter than the package's documented minimums;
update the listed versions to the actual @asyncapi/generator minimums (Node.js
>=18.12.0 and npm >=8.19.0) OR, if those higher versions (Node.js v20.12.0 and
npm v10.5.0) are intended as tested/recommended rather than required, change the
wording to clarify this (e.g., "Tested with Node.js v20.12.0 and npm v10.5.0;
minimum requirements: Node.js >=18.12.0, npm >=8.19.0").
2 participants
Removed the Glee framework installation docs from the "Getting Started" docs
Issue #4559
Summary by CodeRabbit
Documentation