website
website copied to clipboard
[📑 Docs]: suggestions on 'create-asyncapi-document.md' file
What Dev Docs changes are you proposing?
I have some questions and suggestions to discuss that may improve this doc:
-
Can this line be changed at the end from
environmental lighting
toenvironmental lighting conditions
as the same is given here? -
Can the
Event-driven architecture (EDA)
here put in bold letters? -
Removing one extra full stop (.) from the end of this line
-
The
d
in theId
here can capitalized. -
Let's break it down into pieces:
can be changed toLet's break the above code snippet down into pieces:
here -
lets
can be changed tolet's
here -
Also on the same line as above,
This section is used to describe the event names your API will be publishing and/or subscribing to.
, we can change it toThis section is used to describe the event names that your API will be publishing and/or subscribing to.
-
Next is the payload property which is used to understand how the event should look like when publishing to that channel:
it can be changed toNext is the payload property. It is used to understand how the event should look like when publishing to that channel
here
cc: @alequetzalli @derberg @thulieblack
Code of Conduct
- [X] I agree to follow this project's Code of Conduct
/gfi docs
I can work on this if no one else is interested.
I can work on this if no one else is interested.
@depleur We have to discuss with the maintainers about the changes that I've proposed above. After that we can decide whether to work on this or not.
@thulieblack please give your feedback on the changes proposed :eyes: cc: @Mayaleeeee
/enhancement
@AnimeshKumar923 I would like to work on this issue, if was not assigned to anyone.
@AnimeshKumar923 I would like to work on this issue, if was not assigned to anyone.
@alaminthespecial We have to discuss with the maintainers about the changes that I've proposed above. After that we can decide whether to work on this or not.
Hey @AnimeshKumar923, any reply from the maintainers? If yes, I would like to work on this issue
@TheEques Not right now, as there are more important issues to tackle. Let's wait a little more before proceeding with this. This comes under enhancement hence it can be delayed a bit.
Hey @AnimeshKumar923 any progress on the issue status. LMK if it is up for any implementation.
can you please assign me this issue?
@puwun @akshitdevelper currently waiting for feedback from @alequetzalli you can see earlier comments for more context on this issue
@AnimeshKumar923 , Hi , I am looking for some good first issue to solve, and i guess, i can do i it properly, if possible, can you assign this issue to me, it would be a great help.
@demoiverrakada please see this comment for context.
Please see the issues section for some other good first issues
Heyo, stuff like bolding and italicizing randomly goes against our style guide. That said, thank you for taking the time to propose some ideas! Accepted @sharmaachintya08's PR so we can finally close this one 😸