Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: new style guide - Numbers #1251

Closed
Tracked by #1240
quetzalliwrites opened this issue Jan 24, 2023 · 4 comments · May be fixed by #1796
Closed
Tracked by #1240

docs: new style guide - Numbers #1251

quetzalliwrites opened this issue Jan 24, 2023 · 4 comments · May be fixed by #1796
Assignees
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs stale

Comments

@quetzalliwrites
Copy link
Member

quetzalliwrites commented Jan 24, 2023

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?

  • Numbers: Define guidelines for numbers and words, commas in numbers, number ranges, etc.

Where should this go?

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

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

Extra Resources

@quetzalliwrites quetzalliwrites self-assigned this Jan 25, 2023
@quetzalliwrites quetzalliwrites changed the title Numbers docs: new style guide - Numbers Jan 25, 2023
@quetzalliwrites quetzalliwrites added 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Jan 25, 2023
@quetzalliwrites
Copy link
Member Author

Assigning this task to @Maniktherana ✌🏽

@janvi01
Copy link
Contributor

janvi01 commented Apr 1, 2023

Hey, I would like to work on this issue as a Gsod applicant. @alequetzalli @thulieblack

@quetzalliwrites
Copy link
Member Author

Hey @janvi01! Just to clarify, even tho the GSoD applicants are selected, this is a regular docs issue that is not related to GSoD so you can certainly pick it up! 😄

As we've synced offline that you're working already on the first draft, assigning this issue to you now. ✨

Copy link

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 ❤️

@github-actions github-actions bot added the stale label Mar 17, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jul 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs stale
Projects
Status: In progress 😀👍🏽
Development

Successfully merging a pull request may close this issue.

2 participants