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]: changes in usage of command asyncapi generate fromTemplate #1366

Closed
1 task done
Adi-204 opened this issue Feb 18, 2025 · 6 comments · Fixed by #1371
Closed
1 task done

[📑 Docs]: changes in usage of command asyncapi generate fromTemplate #1366

Adi-204 opened this issue Feb 18, 2025 · 6 comments · Fixed by #1371

Comments

@Adi-204
Copy link
Contributor

Adi-204 commented Feb 18, 2025

What Dev Docs changes are you proposing?

On the AsyncAPI Generator usage page, the command asyncapi generate fromTemplate is documented. However, this information is outdated due to the addition of new flags in the command. For the latest updates, refer to the AsyncAPI CLI documentation, which provides details on the new flags and their usage.

Code of Conduct

  • I agree to follow this project's Code of Conduct
Copy link
Contributor

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@Adi-204
Copy link
Contributor Author

Adi-204 commented Feb 18, 2025

Waiting for issue approval by maintainers. Please assign me the issue thanks : )

@derberg
Copy link
Member

derberg commented Feb 19, 2025

hey, isn't it a duplicate of #1367

@Adi-204
Copy link
Contributor Author

Adi-204 commented Feb 19, 2025

@derberg Sir, sorry for unclear explanation of this issue. I am trying to say that Flags written in CLI docs like --no-interactive, --registry-token=, --registry-auth= etc are not present in generator docs as shown below -

  1. Generator docs
    Image

  2. AsyncAPI CLI docs
    Image

User might get confuse if they see both of these usage in docs.

Copy link
Member

derberg commented Feb 20, 2025

ah, yeah, problem is that generator docs are manually updated - best would be to remove the docs and simply link to cli docs - wdyt?

@Adi-204
Copy link
Contributor Author

Adi-204 commented Feb 20, 2025

@derberg sir we can remove usage code snippet and replace it with -

For complete command usage and options, refer to the official AsyncAPI CLI documentation.

Please provide feedback thanks : )

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

Successfully merging a pull request may close this issue.

2 participants