testing-library-docs icon indicating copy to clipboard operation
testing-library-docs copied to clipboard

API is hard to find from landing page

Open redbar0n opened this issue 2 years ago • 4 comments

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.

redbar0n avatar Dec 26 '21 22:12 redbar0n

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.

MatanBobi avatar Dec 27 '21 08:12 MatanBobi

You mean rename the Docs link in the top left?

alexkrolick avatar Dec 31 '21 17:12 alexkrolick

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.

redbar0n avatar Jan 02 '22 17:01 redbar0n

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

polibb avatar Jul 13 '22 13:07 polibb