docs: add note about baked-in templates in README #1722
Conversation
varshitha-besthu
requested review from
Florence-Njeri,
derberg and
asyncapi-bot-eve
as code owners
|
What reviewer looks at during PR reviewThe following are ideal points maintainers look for during review. Reviewing these points yourself beforehand can help streamline the review process and reduce time to merge.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
There was a problem hiding this comment.
@varshitha-besthu I think we should write about what exactly Baked-in Templates,
Below is just suggestion feel free to change it -
Baked-in templates are official AsyncAPI templates shipped with the Generator (@asyncapi/generator). They cover code, docs, configs, and SDKs, and are maintained under packages/templates with a consistent, opinionated structure for reliability and ease of maintenance. It is not recommended to use them in production.
I would suggest you to read - https://www.asyncapi.com/docs/tools/generator/baked-in-templates
Also you need to add same in https://github.com/asyncapi/generator/tree/master/apps/generator#readme
|
There was a problem hiding this comment.
@varshitha-besthu left few comments! do same changes in app/generator/README.md
|
|
||
| You can find above templates and the ones provided by the community in **[this list](https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate)** | ||
|
|
||
| [!IMPORTANT] |
There was a problem hiding this comment.
| [!IMPORTANT] | |
| > [!IMPORTANT] |
|
|
||
|
|
| **Note on Baked-in Templates** | ||
|
|
||
| AsyncAPI Generator also comes with **baked-in templates** - official templates shipped directly inside the Generator (`@asyncapi/generator`). | ||
| They include code, documentation, config, and SDK templates, all maintained under the [`/packages/templates`](./packages/templates) folder with a strict, opinionated structure. |
There was a problem hiding this comment.
| They include code, documentation, config, and SDK templates, all maintained under the [`/packages/templates`](./packages/templates) folder with a strict, opinionated structure. | |
| They include code, documentation, config, and SDK templates, all maintained under the [`/packages/templates`](packages/templates) folder with a strict, opinionated structure. |
|
|
||
| AsyncAPI Generator also comes with **baked-in templates** - official templates shipped directly inside the Generator (`@asyncapi/generator`). | ||
| They include code, documentation, config, and SDK templates, all maintained under the [`/packages/templates`](./packages/templates) folder with a strict, opinionated structure. | ||
|
|
| ⚠️ This feature is experimental and not recommended for production use. | ||
| Instead, we encourage you to try them out and share feedback or contribute with your use cases. |
There was a problem hiding this comment.
Just keep them in same line no need of new line for new sentence.
|
I believe this PR should be closed as it is currently blocking others from contributing. The PR was reviewed 7 days ago and no progress is made by contributor. @varshitha-besthu if you are interested, pls let us know in issue and create a new PR. |
Description
Summary
This PR adds a note about baked-in templates (experimental) in the main
README.mdunder the List of official generator templates section.Why
Changes
Related issue(s)
Resolves #1718