-
-
Notifications
You must be signed in to change notification settings - Fork 637
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]: suggestions on 'create-asyncapi-document.md' file #1945
Comments
/gfi docs |
I can work on this if no one else is interested. |
@depleur @thulieblack please give your feedback on the changes proposed 👀 |
/enhancement |
@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. |
Hey @AnimeshKumar923, any reply from the maintainers? |
@TheEques |
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 |
@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. |
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 😸 |
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:
herelets
can be changed tolet's
hereAlso 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
herecc: @alequetzalli @derberg @thulieblack
Code of Conduct
The text was updated successfully, but these errors were encountered: