website icon indicating copy to clipboard operation
website copied to clipboard

[📑 Docs]: suggestions on 'create-asyncapi-document.md' file

Open AnimeshKumar923 opened this issue 1 year ago • 13 comments

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 to environmental 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 the Id here can capitalized.

  • Let's break it down into pieces: can be changed to Let's break the above code snippet down into pieces: here

  • lets can be changed to let'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 to This 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 to Next 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

AnimeshKumar923 avatar Jul 14 '23 02:07 AnimeshKumar923

/gfi docs

AnimeshKumar923 avatar Jul 14 '23 02:07 AnimeshKumar923

I can work on this if no one else is interested.

depleur avatar Jul 14 '23 10:07 depleur

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

AnimeshKumar923 avatar Jul 14 '23 12:07 AnimeshKumar923

/enhancement

AnimeshKumar923 avatar Jul 20 '23 00:07 AnimeshKumar923

@AnimeshKumar923 I would like to work on this issue, if was not assigned to anyone.

alaminthespecial avatar Jul 21 '23 05:07 alaminthespecial

@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.

AnimeshKumar923 avatar Jul 21 '23 05:07 AnimeshKumar923

Hey @AnimeshKumar923, any reply from the maintainers? If yes, I would like to work on this issue

TheEques avatar Sep 10 '23 08:09 TheEques

@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.

AnimeshKumar923 avatar Sep 11 '23 04:09 AnimeshKumar923

Hey @AnimeshKumar923 any progress on the issue status. LMK if it is up for any implementation.

akshitdevelper avatar Dec 08 '23 14:12 akshitdevelper

can you please assign me this issue?

puwun avatar Jan 07 '24 08:01 puwun

@puwun @akshitdevelper currently waiting for feedback from @alequetzalli you can see earlier comments for more context on this issue

AnimeshKumar923 avatar Jan 07 '24 09:01 AnimeshKumar923

@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 avatar Mar 04 '24 10:03 demoiverrakada

@demoiverrakada please see this comment for context. Please see the issues section for some other good first issues

AnimeshKumar923 avatar Mar 04 '24 17:03 AnimeshKumar923

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 😸

quetzalliwrites avatar Apr 13 '24 00:04 quetzalliwrites