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: add formatting styleguide #1089

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

starlightknown
Copy link

Description

  • ...
  • ...
  • ...

Related issue(s)

Fixes asyncapi/website#1253

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@starlightknown starlightknown changed the title add formatting styleguide docs: add formatting styleguide Mar 7, 2024
@starlightknown
Copy link
Author

migrated PR #1359

@alequetzalli

Copy link

@TRohit20 TRohit20 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bunch of minor changes, otherwise LGTM. Thank you! @starlightknown

docs/style-guide/formatting.md Outdated Show resolved Hide resolved
* Surround the text you want to style with an opening <Remember> tag and a closing </Remember> tag.
* Note that the word 'Remember' does not need to be included within the tags, as it automatically provides the necessary styling.
* Use the following syntax to apply a style:
` <Remember>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be wrong but don't we need triple quotes here?

docs/style-guide/formatting.md Outdated Show resolved Hide resolved
Copy link

@TRohit20 TRohit20 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@quetzalliwrites
Copy link
Member

You rock @starlightknown! ⭐ Thank you for moving this over ❤️

Copy link

This pull request 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 pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request 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 pull request 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 Aug 14, 2024
@thulieblack
Copy link
Member

Not stale, waiting for the automation

@thulieblack thulieblack removed the stale label Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: new style guide - Formatting
4 participants