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 section to AsyncAPI Style Guide #1746

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Recxsmacx
Copy link

Fixes #1694

Add a new .md file for the Formatting section of the AsyncAPI Style Guide.

  • Create a new file formatting.md in the asyncapi.com/docs/community/styleguide/ directory.
  • Add a title "AsyncAPI Style Guide: Formatting" at the top of the file.
  • Add a section for "Notes and Warning Blocks" with guidelines for formatting notes and warning blocks.
  • Add a section for "Code Blocks" with guidelines for formatting code blocks.
  • Add a section for "White Space" with guidelines for using white space in documentation.

Fixes asyncapi#1694

Add a new `.md` file for the Formatting section of the AsyncAPI Style Guide.

* Create a new file `formatting.md` in the `asyncapi.com/docs/community/styleguide/` directory.
* Add a title "AsyncAPI Style Guide: Formatting" at the top of the file.
* Add a section for "Notes and Warning Blocks" with guidelines for formatting notes and warning blocks.
* Add a section for "Code Blocks" with guidelines for formatting code blocks.
* Add a section for "White Space" with guidelines for using white space in documentation.
@thulieblack
Copy link
Member

@Recxsmacx please pick 1 docs issue to work on before opening another and follow the conventional commits

@Recxsmacx Recxsmacx changed the title Add formatting section to AsyncAPI Style Guide docs: Add formatting section to AsyncAPI Style Guide Feb 20, 2025
@Recxsmacx Recxsmacx changed the title docs: Add formatting section to AsyncAPI Style Guide docs: add formatting section to AsyncAPI Style Guide Feb 20, 2025
@Recxsmacx
Copy link
Author

@thulieblack actually I am solving them from the past two days a lot of negative checks were there they are just reopened

@Recxsmacx
Copy link
Author

@thulieblack I have some questions and i messaged you on slack please have a look on it

@thulieblack
Copy link
Member

@Recxsmacx this is not the correct way to start contributing. I understand you are new and would like to solve as many issues as you can but this isn't how we do it.

I would suggest to first close all the open PRs because it looks like you're spamming and first go through the onboarding documents.

Only after that can you start picking the good first issues.

@Recxsmacx
Copy link
Author

@thulieblack it required a lot of time for me to figure out and correct them from the next time i will take care about everything during raising pr

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
2 participants