unkey icon indicating copy to clipboard operation
unkey copied to clipboard

Docs link near at least major features

Open harshsbhat opened this issue 1 year ago • 13 comments

Preliminary Checks

  • [X] I have reviewed https://unkey.com/docs for existing features that would solve my problem

  • [X] I have searched for existing feature requests: https://github.com/unkeyed/unkey/issues

  • [X] This issue is not a question, general help request, or anything other than a feature request directly related to Unkey. Please ask questions in our Discord community: https://unkey.com/discord.

Is your feature request related to a problem? Please describe.

Let's say I am new to semantic caching or need to refer to the documentation for semantic caching while I am on the semantic caching page, that is /semantic-cache. It isn't enjoyable to open the docs in the new tab and then search for the feature I am looking for in the docs. Instead having the topic-specific link on the same page can be very helpful.

image

Describe the solution

Need to figure out a way to add topic-specific docs links at least for the 4-5 major features that we have on the dashboard.

Describe alternatives you have considered (if any)

No response

Additional context

No response

harshsbhat avatar Oct 05 '24 04:10 harshsbhat

I don't get it, what would a change look like?

chronark avatar Oct 05 '24 10:10 chronark

I mean having a link on the /semantics-cache page specific to semantic-cache docs can help tbh. Similar for ratelimit and authorization. As it is a annoying process to open the docs in the new tab and then search for the related features. We can do this for popular and hard to understand features right?

harshsbhat avatar Oct 05 '24 11:10 harshsbhat

ah, so just having a docs link/button somewhere in the top right? I like that

chronark avatar Oct 05 '24 11:10 chronark

ah, so just having a docs link/button somewhere in the top right? I like that

yep, specific to the topic link. we will need to figure out how to place it to make sure its not looking too cluttered tho

harshsbhat avatar Oct 05 '24 11:10 harshsbhat

Please hold off on that, we will have some discussions around restructuring the page header next week

chronark avatar Oct 05 '24 11:10 chronark

Please hold off on that, we will have some discussions around restructuring the page header next week

Yeah, I already have 2-3 issues to work on 😊

harshsbhat avatar Oct 05 '24 11:10 harshsbhat

Hey, @chronark how about having just a Read More link somewhere here?

Not a BUTTON but just a link to the relevant docs. Should be helpful for at least three major features i.e.

Ratelimiting, API keys, Semantic cache

image

screenshot is edited and not actual changes in code

harshsbhat avatar Oct 12 '24 12:10 harshsbhat

didn't see this, I like that idea

chronark avatar Oct 25 '24 11:10 chronark

Shouldn't this be 50 points too? @chronark

harshsbhat avatar Oct 25 '24 12:10 harshsbhat

/award 50

chronark avatar Oct 30 '24 11:10 chronark

Awarding harshsbhat: 50 points 🕹️ Well done! Check out your new contribution on oss.gg/harshsbhat

oss-gg[bot] avatar Oct 30 '24 11:10 oss-gg[bot]

/assign

djnovin avatar Dec 26 '24 23:12 djnovin