-
-
Notifications
You must be signed in to change notification settings - Fork 785
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
Comments
Waiting for issue approval by maintainers. Please assign me the issue. |
Can i work on this? |
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. |
The issue exists because of asterisks used in heading markup like |
@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 : ) |
@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. |
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 : ) |
@Adi-204 You can directly create a PR in CLI repo. Just link this issue in that PR using |
@KunalNasa That's exactly how docs are mirrored from different repositories like cli, generator, etc to this website repository. |
@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 : ) |
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:
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:
Code of Conduct
The text was updated successfully, but these errors were encountered: