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 Bug 🐞 report]: Inconsistent Formatting Asterisk (*) Mark Appearing Under "On This Page" Section on CLI Architecture page #3643

Closed
1 task done
Adi-204 opened this issue Feb 3, 2025 · 10 comments · Fixed by asyncapi/cli#1673
Labels

Comments

@Adi-204
Copy link

Adi-204 commented Feb 3, 2025

Describe the bug you found in AsyncAPI Docs.

I noticed that the "On This Page" section of the CLI Architecture documentation contains asterisks (*) before section names, such as:

Image

However, this formatting is inconsistent with other sections of the AsyncAPI documentation, where the asterisks are not present.

Attach any resources that can help us understand the issue.

Steps to Reproduce:

  1. Navigate to the CLI Architecture page.
  2. Observe the "On This Page" section on the right side.
  3. Compare it with other sections under the Tools > CLI category.

Image

Code of Conduct

  • I agree to follow this project's Code of Conduct
@Adi-204
Copy link
Author

Adi-204 commented Feb 3, 2025

Waiting for issue approval by maintainers. Please assign me the issue.

@AST0008
Copy link

AST0008 commented Feb 3, 2025

Can i work on this?

@KunalNasa
Copy link
Contributor

This issue is caused by extra asterisks in markdown/docs/tools/cli/architecture.md. I believe this was done to make the text bold, but it’s not necessary. We can simply remove those asterisks from the markdown file.

@anshgoyalevil
Copy link
Member

The issue exists because of asterisks used in heading markup like ## **something**, which is equivalent to ## something
Feel free to create a PR. This is the file that needs to be changed https://github.com/asyncapi/cli/blob/master/docs/architecture.md

@anshgoyalevil anshgoyalevil added the good first issue Good for newcomers label Feb 16, 2025
@Adi-204
Copy link
Author

Adi-204 commented Feb 16, 2025

@anshgoyalevil Sir so, this issue belongs to the CLI repo. Should I create a new issue there, or can we transfer this one to the CLI repo? thanks : )

@KunalNasa
Copy link
Contributor

@Adi-204 I don't think this issue is only related to cli repo as I have fixed it in dev yesterday. I have mentioned the file in website repo in my previous comment.

@Adi-204
Copy link
Author

Adi-204 commented Feb 16, 2025

Yes I know that file but only the asyncapi-bot is doing commits in that file so basically they might have system where if changes are made in actual repo than it will be done by asyncapi-bot in website repo. I am not completely sure so maybe maintainers can explain better. thanks : )

@anshgoyalevil
Copy link
Member

@Adi-204 You can directly create a PR in CLI repo. Just link this issue in that PR using fixes #abcd syntax.

@anshgoyalevil
Copy link
Member

Yes I know that file but only the asyncapi-bot is doing commits in that file so basically they might have system where if changes are made in actual repo than it will be done by asyncapi-bot in website repo. I am not completely sure so maybe maintainers can explain better. thanks : )

@KunalNasa That's exactly how docs are mirrored from different repositories like cli, generator, etc to this website repository.

@Adi-204
Copy link
Author

Adi-204 commented Feb 16, 2025

@anshgoyalevil maybe can I create an issue regarding updation of CONTRIBUTING.md. Where we can mention a Note in section regarding "issues related to tools-docs can be directly created in tools repo"? thanks : )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants