You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 #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)
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
The text was updated successfully, but these errors were encountered: