[Docs Bug 🐞 report]: incorrect description of asyncapi in template documentation #1400
Comments
|
hey @KunalNasa i want to work on this issue , could you please assigne to me. |
|
@Arun12-sketch , issues are not assigned here. You can raise PR after the issue gets approved by maintainers. |
|
@KunalNasa you are right, wanna open a PR or? |
|
@derberg may I wait for @Arun12-sketch ? As he wanted to fix this issue. I will open a PR if he doesn't respond in the next 12 hours. |
|
@KunalNasa I am doing this issue . |
|
@KunalNasa are you fine with this? |
|
@derberg yes, no problem. |
|
@Arun12-sketch go ahead with PR please |
|
@Arun12-sketch I don’t think we need to go over the asynapi explanation again, especially with any changes. We’ve already covered the meaning of asyncapi in the first point, and I believe that’s sufficient for users to understand. Explaining it with additional modifications in later points could lead to confusion. I think it would be better to discuss these doubts with the maintainers. They have a better understanding of this topic than I do, and currently I’m also a contributor like you. |
|
Hi @Arun12-sketch, are you still working on this issue? It's been two weeks, and there are no updates on the PR. Please let me know if you need any help with the PR. I would be happy to help. Or, if you have changed your mind or have other commitments, that is totally fine. Just drop a message so that I can proceed with the PR. |
|
@KunalNasa yeah, it is one of those https://www.linkedin.com/feed/update/urn:li:activity:7295834558405431298/ Just go ahead and work on a PR |
Describe the bug you found in AsyncAPI Docs.
There is an incorrect definition of asyncapi variable on this page: page under the section of "Template generation process".
Here it is stated as "asyncapi is the original AsyncAPI document injected into your template file by default."
This is incorrect because according to the generation process steps mentioned on the introduction page of generator docs.
"The asyncapi variable is not the original AsyncAPI document but a processed version with helper functions."
Also, this contradicts the later statement that the generator passes both asyncapi and the original AsyncAPI document.
Suggested Fix on Template page:
The asyncapi (which is an instance of AsyncAPIDocument) is injected into your template file by default.
The generator passes both the asyncapi, the original AsyncAPI document, and the params to the Template Context.
Attach any resources that can help us understand the issue.
Definition of asyncapi on Generator introduction page
Incorrect definition on template page under the section of "Template generation process"
Code of Conduct
The text was updated successfully, but these errors were encountered: