Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs Bug 🐞 report]: update the docs for asyncapi new command #1670

Closed
1 task done
Adi-204 opened this issue Feb 15, 2025 · 4 comments · Fixed by #1671
Closed
1 task done

[Docs Bug 🐞 report]: update the docs for asyncapi new command #1670

Adi-204 opened this issue Feb 15, 2025 · 4 comments · Fixed by #1671

Comments

@Adi-204
Copy link
Contributor

Adi-204 commented Feb 15, 2025

Describe the bug you found in AsyncAPI Docs.

Recently in patch for v2.16.2 the implementation for asyncapi new command was changed. But in below few places the updates are not done -

  1. On page - https://www.asyncapi.com/docs/tools/cli/architecture inside Detailed Explanation of Key Directories in the CLI new/
  2. Inside EXAMPLES for command asyncapi new file https://www.asyncapi.com/docs/tools/cli/usage#asyncapi-new-file

Attach any resources that can help us understand the issue.

Image

Image

Code of Conduct

  • I agree to follow this project's Code of Conduct
@Adi-204
Copy link
Contributor Author

Adi-204 commented Feb 15, 2025

@AayushSaini101 Could you please review this? I would be happy to proceed with the docs changes thanks : )

@AayushSaini101
Copy link
Collaborator

@AayushSaini101 Could you please review this? I would be happy to proceed with the docs changes thanks : )

@Adi-204 what kind of updates are missing can you explain ?

@Adi-204
Copy link
Contributor Author

Adi-204 commented Feb 16, 2025

@AayushSaini101
In new/ it is not use to create only files so we can improve content by writing 'Create a new AsyncAPI project, specification files, or templates for clients and applications.'
In EXAMPLES for command asyncapi new file it is written asyncapi new - start file creation in interactive mode (this was possible in older version) but it should be asyncapi new file in current version .
thanks : )

@AayushSaini101
Copy link
Collaborator

@AayushSaini101 In new/ it is not use to create only files so we can improve content by writing 'Create a new AsyncAPI project, specification files, or templates for clients and applications.' In EXAMPLES for command asyncapi new file it is written asyncapi new - start file creation in interactive mode (this was possible in older version) but it should be asyncapi new file in current version . thanks : )

@Adi-204 thanks, create a PR. thanks : )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants