docs: new style guide - Styling

[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?

• Styling: Design your styling requirements for CSS code, font size, markdown, lists, images, diagrams, tables, etc.

Where should this go?

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

Create the following directory and place your file there: asyncapi.com/docs/community/styleguide/styling.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

[kirtanchandak]

Hey, how to I get started for this issue ?

[quetzalliwrites]

Hey there @kirtanchandak, apologies for just seeing this message 😅 .

To get started on your first docs contribution, DM me on AsyncAPI Slack for onboarding tasks! 😄✌🏽 I look forward to hearing from you and I hope you're still interested in contributing! ✨

[Dule-martins]

Hi @alequetzalli, hope you are doing well. Just to be sure about your previous message here https://github.com/asyncapi/website/issues/1258#issuecomment-1550525676 Is this the issue you meant when you said "up"?

[quetzalliwrites]

No @Dule-martins, I said I have no style guide tasks for you. Please stop trying to open new PRs; if you want to contribute to our docs you should finish the original PR you opened months ago in the community repo.

[Dule-martins]

Okay, Thanks for the information @alequetzalli Working on that with @derberg and waiting for his feedback.

[derberg]

@Dule-martins hey, what do you need? Please ping me in the community repo related issue

[Dule-martins]

Okay, Thanks for the information @alequetzalli Working on that with @derberg and waiting for his feedback.

Ya! I have gotten the feedback I was waiting for. @derberg your comment under #442 issue is the feedback.

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