[📑 Docs]: consistent formatting and writing style throughout the documentation

[bandantonio]

What Dev Docs changes are you proposing?

Motivation

Many documentation pages use different formatting for the same content elements or don't use it at all. For example:

• The first occurrence of a specific AsyncAPI-related term can either be italicized or not.
• Abbreviations can be used with their full forms (in different variants) within a single page.
• Bold formatting is used chaotically to grab attention and highlight ui elements the user should click on.
• No consistent wording within a single page. For example:
  • The above diagram describes
  • The diagram above shows
  • The above diagram depicts

So, the idea is to make AsyncAPI docs more consistent by leveraging common formatting to the content and using the same word forms and constructions throughout the docs. Even though, the style guide for AsyncAPI docs is still under development (or not 😁) (see asyncapi/community#1683 ) with no specific TTM, certain formatting is consistent regardless of the style guide used. It can be applied anyway, for example, for the points mentioned above.

Tasks

(the list will be expanded gradually as soon as new sections fall within the scope)

• [📑 Docs]: Concepts: Improve writing style #3374
• [📑 Docs]: Concepts/AsyncAPI Document: Improve writing style #3385
• [📑 Docs]: Concepts/AsyncAPI Document/Tags: Improve writing style #3410

Code of Conduct

• I agree to follow this project's Code of Conduct

[bandantonio]

@quetzalliwrites or someone else, please assign me to this issue

[anshgoyalevil]

Assigned it to you, @bandantonio 🚀

[bandantonio]

Hi @sushmithashettigar29
Yes, I'm still working on this one, no worries 😌

[sambhavgupta0705]

@bandantonio what's the update on this issue?

[bandantonio]

@sambhavgupta0705 working on it. Just a bit slow while the Mentorship/Maintainership program is in progress.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[KariraLakshya]

Hi @anshgoyalevil
Can i work on this issue??