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

API is hard to find from landing page #976

Open
redbar0n opened this issue Dec 26, 2021 · 4 comments
Open

API is hard to find from landing page #976

redbar0n opened this issue Dec 26, 2021 · 4 comments

Comments

@redbar0n
Copy link

Description, screenshot and reproduction here:
https://twitter.com/magnemg/status/1473314668815032323?s=21

Expected to see the API in the navbar, on mobile (latest iOS Safari) and on desktop.

@MatanBobi
Copy link
Member

MatanBobi commented Dec 27, 2021

Thanks for opening this one :)
I'll elaborate a little bit here since a reference to our conversation in twitter isn't sufficient IMO.

What @redbar0n says here is that as an API focused site, we should have a link to the API pages at our top level navigation:

image

Just for a reference, it looks like RTK are doing something similar already.

image

What do you all think? It's open for discussion, the implementation is quite easy.

@alexkrolick
Copy link
Collaborator

You mean rename the Docs link in the top left?

@redbar0n
Copy link
Author

redbar0n commented Jan 2, 2022

You mean rename the Docs link in the top left?

No, not actually. That kind of illustrates the problem, because I also thought Docs would lead me to the API... But in fact API is a separate page from Docs.

What I'm thinking about is adding the API link in the bottom of the page to the navbar.

@polibb
Copy link

polibb commented Jul 13, 2022

I agree it is a bit daunting for me when I enter the main page looking for the API and do not find it directly. I assume I have to find it through the Docs section, but at this point I'm already a few clicks away and get distracted by all the options in the Docs: Should I look into the Core API or Frameworks > React Testing Library? Or DOM Testing Library, since it is the core library? Eventually I do find what I'm looking for, but just wanted to support this thread since that's the reason it's here and it will be beneficial IMO

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants
@redbar0n @alexkrolick @MatanBobi @polibb and others