asyncapi / website

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

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

Open bandantonio opened 2 weeks ago

bandantonio commented 2 weeks ago

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:

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 #1240 ) 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)

Code of Conduct

bandantonio commented 2 weeks ago

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