Skip to content
New issue

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

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

Already on GitHub? # to your account

[📑 Docs]: Improvement in Installation guide #1372

Open
1 task done
Adi-204 opened this issue Feb 21, 2025 · 3 comments
Open
1 task done

[📑 Docs]: Improvement in Installation guide #1372

Adi-204 opened this issue Feb 21, 2025 · 3 comments

Comments

@Adi-204
Copy link
Contributor

Adi-204 commented Feb 21, 2025

What Dev Docs changes are you proposing?

The current installation guide for the AsyncAPI Generator includes installation steps for the AsyncAPI CLI, but these steps differ from the actual installation guide provided within the CLI documentation. Specifically:

  1. Mac: The guide only mentions brew install asyncapi, which may not cover all necessary details.
  2. Linux: The instructions differ from what is officially documented in the CLI guide.

This inconsistency can cause confusion for users, especially those unfamiliar with installation nuances.
Proposed Solution
Should we manually update the installation guide to align with the CLI documentation, or would it be better to provide a brief explanation and a direct link redirecting users to the official AsyncAPI CLI installation guide?

Code of Conduct

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

Adi-204 commented Feb 21, 2025

@derberg sir can you please provide feedback thanks : )

@derberg
Copy link
Member

derberg commented Mar 3, 2025

we should probably solve it the same way as #1371 ? wdyt?

@Illucious
Copy link

This looks like a good first issue for me to get started on contributing. I read #1371 and got a general understanding of how to do this. Can I get started on this issue?

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

3 participants