docs: remove AsyncAPI CLI command bash and replace with CLI docs link #1371
Conversation
Adi-204
requested review from
Florence-Njeri,
derberg and
asyncapi-bot-eve
as code owners
|
WalkthroughThe documentation for the AsyncAPI CLI has been revised to enhance clarity and organization. The previous section detailing command usage, arguments, flags, and examples has been removed and replaced with a single line that directs users to the official AsyncAPI CLI documentation for complete command usage and options. The new heading format for the command usage is now presented as Changes
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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
CodeRabbit Configuration File (
|
![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 (2)
apps/generator/docs/usage.md (2)
7-13: Refined Navigation List for Usage DocumentationThe bullet list under "There are two ways to use the generator:" has been restructured to clearly enumerate the different usage approaches. This update improves navigation and makes it easier for users to jump to the specific sections they need.
Please verify that the anchor links (for example, the one in "Using as a module/package") correctly resolve in your documentation rendering environment. If necessary, consider making the anchor IDs more consistent (e.g., using hyphenation) to avoid any potential linking issues.
15-19: Directing Users to Official CLI DocumentationThe "AsyncAPI CLI" section now clearly indicates that complete command usage and options are available in the official AsyncAPI CLI documentation. This fulfills the PR objective to remove the direct Bash command details in favor of a streamlined reference, thereby reducing maintenance overhead and ensuring users always have access to up-to-date information.
As a follow-up, please consider whether the inline header "
asyncapi generate fromTemplate ASYNCAPI TEMPLATE" should remain as a reference or if it might be redundant given that users are being redirected to the comprehensive CLI docs.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
apps/generator/docs/usage.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Test generator as dependency with Node 20
- GitHub Check: Test generator as dependency with Node 18
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Test NodeJS PR - macos-13
derberg
changed the title
apps/generator/docs/usage.md
Outdated
| - [`asyncapi generate fromTemplate ASYNCAPI TEMPLATE`](#asyncapi-generate-fromtemplate-asyncapi-template) | ||
| - [Global templates installed with `yarn` or `npm`](#global-templates-installed-with-yarn-or-npm) | ||
| - [CLI usage examples](#cli-usage-examples) | ||
| - [CLI usage with Docker](#cli-usage-with-docker) | ||
| - [CLI usage with `npx` instead of `npm`](#cli-usage-with-npx-instead-of-npm) |
There was a problem hiding this comment.
do we need this?
navigation is automatically rendered anyway - look https://www.asyncapi.com/docs/tools/generator/usage
There was a problem hiding this comment.
@derberg Sir, my apologies for the oversight. The table of contents was generated automatically based on the section headings (##, ###, etc.). I will change it.
|
|
/rtm |
Description
We need to manually change the usage of command
asyncapi generate fromTemplate ASYNCAPI TEMPLATEin generator docs according to CLI. So we can replace the usage bash with direct link to commandasyncapi generate fromTemplate ASYNCAPI TEMPLATE.Related issue(s)
Fixes: #1366
Summary by CodeRabbit