docs: structure of a AsyncAPI document #1922
Conversation
✅ Deploy Preview for shimmering-choux-eb0798 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
TRohit20
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Fran Méndez <[email protected]>
Co-authored-by: Fran Méndez <[email protected]>
There was a problem hiding this comment.
I want to say thanks @TRohit20 for your valuable contribution to the docs 🙌
I left some comments, suggestions and change requests.
Additionally, I would like to recommend you to use a tool such as Grammarly to fix some minor typos and improve the grammar. I use it for documentation and works like a charm!
Co-authored-by: Sergio Moya <[email protected]>
quetzalliwrites
added
📑 docs
area/docs
|
Hey @TRohit20, any update here? 🙂 |
|
Hey @jonaslagoni , Yes. Currently I am working on my initial draft for Request/Reply Document referring to the issue here. I will be done with the draft and raising a PR for the same in couple of days. Post which, I will be working on the weekend to make the required edits and modifications based on the suggestions provided for the document in this PR. I will have changes made and update the files soon. Thanks :) |
There was a problem hiding this comment.
@alequetzalli ready for final review from your side
I decided to no longer make comments but make changes directly, feel free to revert anything you do not agree with -> b4e5b61
- I updated examples to be consistent and follow v3
- added more
youso it is not as boring as spec document and targets reader - diagrams updates and naming + use
LRstyle as they were hard to read when defaultTDwas used
|
/rtm |
Description
As part of Google Season of Docs 2023 at AsyncAPI, we're going to write in-depth explanations of the different sections of an AsyncAPI document to avoid difficulties in implementing EDAs.
For this document issue, we'll introduce the structure of a AsyncAPI document, why it is necessary and the root elements of it.
Related issue
This task is part of the GSoD Docs EPIC: #1508.
Resolves #1508