asyncapi-react icon indicating copy to clipboard operation
asyncapi-react copied to clipboard

Anchor-link to a specific channel

Open vanyakosmos opened this issue 3 years ago • 4 comments

Description

It would be very convenient to be able to create link to specific channel in documentation.

By opening link with channel anchor asyncapi-docs should open appropriate accordion-item and scroll to the channel.

Reasons

Convenience.

Attachments

eg: https://example.com/asyncapi/#payments-order-paid

vanyakosmos avatar May 23 '22 15:05 vanyakosmos

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup 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.

github-actions[bot] avatar May 23 '22 15:05 github-actions[bot]

@vanyakosmos Hi! Thanks for the issue. Anchor to operations isn't enough for you? https://github.com/asyncapi/asyncapi-react/blob/next/docs/features/anchors.md#details

magicmatatjahu avatar May 23 '22 16:05 magicmatatjahu

wellp, making url by hands is not the greatest UX I've seen :)

Docs are a little bit outdated, but anchoring section id works as I wanted:

https://example.com/#asyncapi--channels--acquiring-payment-received

Would be cool to have some shortcut, as, for example, github has for headers in markdown documents (link icon):

Screenshot 2022-05-23 at 20 34 10

Or adding anchor dynamically when you open a section (as swagger does), it would be even more convenient (and easier to implement).

vanyakosmos avatar May 23 '22 17:05 vanyakosmos

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

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 :heart:

github-actions[bot] avatar Sep 21 '22 00:09 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

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 :heart:

github-actions[bot] avatar Jan 21 '23 00:01 github-actions[bot]