asyncapi / website

AsyncAPI specification website
https://www.asyncapi.com
Apache License 2.0
478 stars 617 forks source link

[📑 Docs]: Deduplicate content and replace it with reusable fragments #3261

Closed bandantonio closed 4 days ago

bandantonio commented 2 weeks ago

What Dev Docs changes are you proposing?

There are at least 15 files across documentation that have duplicated content related to contribution guidelines and asking questions. I strongly believe that these content chunks should be added to Markdown files as reusable components to leverage the DRY and single source of truth principles. This is a way to avoid falling into anti-patterns like the solutions provided for the issue #3176

15 files: documentation contributor question

1

15 files (24 occurrences): Tag me in your AsyncAPI Doc PRs

2

6 files: Docs contributor questions

3

15 files: To get started as a Docs contributor

4

[!NOTE] I believe that documentation contains even more duplicated fragments that I mentioned above, so a preliminary audit of pages is highly recommended.

[!NOTE] I will take care of this issue

Code of Conduct

ishwarthecodddr commented 2 weeks ago

could you explain more with a example .