redoc icon indicating copy to clipboard operation
redoc copied to clipboard

Linking to certain attributes

Open karussell opened this issue 9 years ago • 3 comments

I just had the idea that it would be useful to link directly to a property e.g. sometimes we get questions and we could then just say, please see the allowed_vehicle property and link it. The user would be scrolled down to the correct location and see the property highlighted 'somehow' and can read the explanation. (You did a cool job already via #56 which makes it already useful and nice for us and we will integrate it soon regardless of further features ;))

Instead the user now has to search manually through the docs to read everything and place it correctly.

karussell avatar Jun 29 '16 21:06 karussell

Good idea 👍 Will think about it after public release.

RomanHotsiy avatar Jun 29 '16 21:06 RomanHotsiy

It has been a long time but as promised we have now deployed our documentation - thanks again for this nice tool :grin:

Now we are stumbling more often over the challenge when customer ask us about a specific feature or attribute or available values where we would love to just send them a link. Would an implementation create unique anchors and then JS would open nodes until the anchor is visible?

An additional problem is that the search is suboptimal for specific attributes (see #562) - highly likely because of implementing the solution for #56 :)

karussell avatar Mar 26 '19 21:03 karussell

Great idea! It's a pain to share links to specific param.

klyushkov avatar Jul 01 '22 07:07 klyushkov