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

Anchor-link to a specific channel #599

Closed
vanyakosmos opened this issue May 23, 2022 · 5 comments
Closed

Anchor-link to a specific channel #599

vanyakosmos opened this issue May 23, 2022 · 5 comments
Labels

Comments

@vanyakosmos
Copy link

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

@github-actions
Copy link

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.

@magicmatatjahu
Copy link
Member

@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

@vanyakosmos
Copy link
Author

vanyakosmos commented May 23, 2022

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).

@github-actions
Copy link

This issue 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 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 ❤️

@github-actions github-actions bot added stale and removed stale labels Sep 21, 2022
@github-actions
Copy link

This issue 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 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 ❤️

@github-actions github-actions bot added the stale label Jan 21, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants