generator
generator copied to clipboard
[📑 Docs]: Provide content for `Introduction` document
What Dev Docs changes are you proposing?
https://github.com/asyncapi/generator/blob/master/docs/index.md
This document should address the following topics:
- overview of what generator is (some technical input is already in the Readme of generator repo and in https://github.com/asyncapi/template-for-generator-templates)
- intro that the use of the generator makes sense only if it is used with a
templateandasyncapidocument. 2-3 paragraphs of explanation that generator is a tool with set of features that enable you to generate anything basing on the AsyncAPI document as input and a template that defines what has to be generated. Could be first diagram here actually, that visualize this simple explanation. 2 boxes (templateandasyncapi file) with arrows pointing to boxgeneratorand thegeneratorbox with arrow pointing to a box calledclient library/docs/application -> literally anything(you can choose a better name :wink:)
cc @pratik2315 @Florence-Njeri
Code of Conduct
- [X] I agree to follow this project's Code of Conduct