docs: new style guide - Formatting

[quetzalliwrites]

Let's finally get around to creating, designing, and incorporating an AsyncAPI Style Guide!

Why the need?

In tech jobs, we often focus on our technology's technical aspects, such as functionality and performance. However, the documentation for our technology is equally important to the code itself. A style guide ensures consistency and clarity, establishes a consistent voice and tone in your documentation, makes it easier for multiple writers to work together on a single doc, and helps ensure documentation is accurate and up-to-date. When all of your technical writers follow the same guidelines, it's easier for readers to find the information they need and understand how to use your product or OSS technology.

What section of the AsyncAPI Style Guide is this issue for?

• Formatting: Define guidelines for formatting notes and warning blocks, code blocks, white space, etc.

Where should this go?

Let's create a new .md file for only the Formatting section of the new AsyncAPI Style Guide.

Create the following directory and place your file there: asyncapi.com/docs/community/styleguide/formatting.md.

Extra Resources

• Write the Docs: Style Guides
• Gatsby Style Guide
• Gatsby Docs Structure & Documentation Types
• Mozilla Style Guide
• Google Style Guide
• Microsoft Style Guide

[quetzalliwrites]

heyooo @starlightknown, would you like to pick up this task? 😄

[starlightknown]

Yes please! Assign it to me

[quetzalliwrites]

it's yours @starlightknown !!! ✨✨✨✨

[starlightknown]

hey @alequetzalli there's already docs and community directories under pages. Do you want me to create another one? and community is not under docs. It's like - pages\docs or pages\community

[quetzalliwrites]

No, this is a new content bucket in Docs. It is still being proposed, but there are many discussions so far about this in other issues.

Let me know if that makes sense :)

[starlightknown]

No, this is a new content bucket in Docs. It is still being proposed, but there are many discussions so far about this in other issues.

Let me know if that makes sense :)

Yeah but when I reviewed few PRs, each contributor had placed their md files in different locations. Some in pages and some in other places. Looks like all are kinda confused?

[quetzalliwrites]

Yes Devi, thank you for calling this out. Glad to know whenever there is confusion :)

Essentially, we opened this Style Guide EPIC issue before we'd finished deciding whether or not we were adding another content bucket to the Docs: Community. At this point in time, the community vote already went in favor and we are supposed to add a Community content bucket to our Docs homepage. (Sorry, I can't remember at the top of my head where that PR is and I think I need to hunt it down again 😅 .)

To summarize, the Style Guide will be placed in the following directory that we will add: asyncapi.com/docs/community/styleguide

Does this make sense now? :)

@starlightknown

[quetzalliwrites]

HA, now I'm the one playing pingy pongy with you @starlightknown 😄😂

[starlightknown]

omg sorry @alequetzalli yes that does make sense, let me change it

[starlightknown]

Hey @alequetzalli the PR has been open for long time. I never got a review on it but just pings in issue so I left it as it is till now as I didn't know if my progress in that PR is right or not.

[quetzalliwrites]

Yes, you're right @starlightknown! sorry about that, my bad... reviewing this today and I will be able to prioritize Style Guide tasks now that the GSoD onboarding is done 😄✌🏽

Thank you for being so patient!

[github-actions[bot]]

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

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 :heart: