docs(cli): update latest cli documentation #3551

asyncapi-bot · 2025-01-06T12:37:43Z

Updated cli documentation is available and this PR introduces update to cli folder on the website

Summary by CodeRabbit

Documentation
- Added new CLI Architecture documentation
- Updated documentation weight for CLI context and metrics collection pages
- Enhanced CLI usage documentation with new proxy-related flags for convert, optimize, and validate commands

coderabbitai · 2025-01-06T12:37:52Z

Walkthrough

This pull request introduces documentation updates for the AsyncAPI CLI, focusing on enhancing the documentation structure and adding new proxy-related functionality. A new architecture documentation file has been created to provide comprehensive insights into the CLI's structure and components. Additionally, several existing documentation files have had their metadata weights adjusted, and the usage documentation has been updated to include new proxy host and port flags for convert, optimize, and validate commands.

Changes

File	Change Summary
`markdown/docs/tools/cli/architecture.md`	New documentation file added detailing CLI architecture, components, and use cases
`markdown/docs/tools/cli/context.md`	Metadata weight updated from 50 to 60
`markdown/docs/tools/cli/metrics_collection.md`	Metadata weight updated from 60 to 70
`markdown/docs/tools/cli/usage.md`	Metadata weight updated from 40 to 50; Added `--proxyHost` and `--proxyPort` flags to convert, optimize, and validate commands

Poem

🐰 Hop, hop, CLI's new dance!
Proxy flags now take their stance
Architecture mapped with care
Documentation beyond compare
AsyncAPI's toolkit grows so bright! 🚀

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?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

netlify · 2025-01-06T12:38:02Z

✅ Deploy Preview for asyncapi-website ready!

Name	Link
🔨 Latest commit	`4069e83`
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/677bce9aa49184000802816b
😎 Deploy Preview	https://deploy-preview-3551--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 site configuration.

codecov · 2025-01-06T12:39:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (fe09451) to head (4069e83).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #3551   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           19        19           
  Lines          668       668           
=========================================
  Hits           668       668

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

asyncapi-bot · 2025-01-06T12:41:32Z

⚡️ Lighthouse report for the changes in this PR:

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

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

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

markdown/docs/tools/cli/architecture.md (2)
15-70: Fix formatting inconsistencies in the directory structure section.

There are multiple instances of loose punctuation marks in the bullet points. Consider standardizing the spacing after bullet points.

Apply consistent spacing in bullet points:
- - `config/`: Stores configuration-related files for commands.   - `generate/`: Generates...
+ - `config/`: Stores configuration-related files for commands.
+ - `generate/`: Generates...
🧰 Tools

🪛 LanguageTool

[uncategorized] ~21-~21: Loose punctuation mark.
Context: ...ated files for commands. - generate/: Generates typed models or other artifac...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...les using templates. - models.ts: Defines the models used during generati...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...odels used during generation. - new/: Creates a new AsyncAPI file. - **Fi...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...s file creation logic. - glee.ts: Related to Glee, a tool for event-drive...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~29-~29: Loose punctuation mark.
Context: ...ven microservices. - template.ts: Manages templates for new projects. -...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~30-~30: Loose punctuation mark.
Context: ...templates for new projects. - start/: Implements starting functionalities lik...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...ir references together. - convert.ts: Converts AsyncAPI documents from older ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~37-~37: Loose punctuation mark.
Context: ...n documents into AsyncAPI. - diff.ts: Compares two AsyncAPI documents. - `f...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~38-~38: Loose punctuation mark.
Context: ... two AsyncAPI documents. - format.ts: Converts AsyncAPI documents from any fo...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...to YAML, YML, or JSON. - optimize.ts: Optimizes AsyncAPI documents for perfor...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~40-~40: Loose punctuation mark.
Context: ...cuments for performance. - pretty.ts: Beautifies the AsyncAPI spec file (inde...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...ed spec to a new file. - validate.ts: Validates AsyncAPI documents for correc...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...tralized error definitions. - flags/: Defines CLI flags and their behavior. ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...I flags and their behavior. - hooks/: Event hooks used for customization. -...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~51-~51: Loose punctuation mark.
Context: ...ks used for customization. - models/: Core data models used across the applic...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...sed across the application. - utils/: Utility functions for common operations...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ogic for CLI commands. - global.d.ts: Global TypeScript definitions. - `glo...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...TypeScript definitions. - globals.ts: Stores global variables and configurati...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~58-~58: Loose punctuation mark.
Context: ...bles and configurations. - parser.ts: Parses AsyncAPI documents. --- #### *...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~66-~66: Loose punctuation mark.
Context: ... data or files for testing. - hooks/: Tests related to hooks. - `integratio...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~67-~67: Loose punctuation mark.
Context: ...sts related to hooks. - integration/: Integration tests to verify end-to-end ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~68-~68: Loose punctuation mark.
Context: ... end-to-end functionality. - system/: System-level tests. - unit/: Unit t...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...ystem/: System-level tests. - unit/`: Unit tests for individual modules or fu...

(UNLIKELY_OPENING_PUNCTUATION)

98-98: Enhance the conclusion with a more professional tone.

Consider revising the concluding sentence to maintain a more professional documentation tone.
-This structure ensures the CLI is modular, scalable, and easy to maintain. Let me know if you need further clarification or additional details!
+This structure ensures the CLI is modular, scalable, and easy to maintain. Please refer to the specific command documentation for detailed usage instructions.
🧰 Tools

🪛 LanguageTool

[style] ~98-~98: This expression usually appears with a “please” in front of it.
Context: ...odular, scalable, and easy to maintain. Let me know if you need further clarification or ad...

(INSERT_PLEASE)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fe09451 and 4069e83.

📒 Files selected for processing (4)

markdown/docs/tools/cli/architecture.md (1 hunks)
markdown/docs/tools/cli/context.md (1 hunks)
markdown/docs/tools/cli/metrics_collection.md (1 hunks)
markdown/docs/tools/cli/usage.md (7 hunks)

✅ Files skipped from review due to trivial changes (2)

markdown/docs/tools/cli/metrics_collection.md
markdown/docs/tools/cli/context.md

🧰 Additional context used

🪛 LanguageTool

markdown/docs/tools/cli/architecture.md

[uncategorized] ~21-~21: Loose punctuation mark.
Context: ...ated files for commands. - generate/: Generates typed models or other artifac...