Consider listing getAll queries explicitly in the API documentation

[gregtatum]

(re-filed from testing-library/dom-testing-library#200)

Problem description:

As a user, I would like quick access to the API documentation.

Sidebar at: https://testing-library.com/docs/api-queries

The sidebar lists all of the queries that are available, and is an easy reference when I'm deep in the middle of writing tests. However, the getAll functions are not explicitly listed. Since I'm writing tests, I'm looking to quickly get the information I need to accomplish my task, and missed the notices and sub-paragraphs about the getAll functions.

As a new user, I wrote the following in a test, since I didn't realize that these convenience functions existed.

verticalIndicators.querySelectorAll('[data-testid="vertical-indicator-line"]')

Suggested solution:

List all available API methods in the sidebar.

[alexkrolick]

Listing all methods would be 4x as long (possibly 6x if we add async), and duplicate a lot of content, so that seems a bit unwieldy.

Maybe we could reorganize to introduce the query types at the top, with a nav item for each kind (queryAll, query, get, getAll)

[kentcdodds]

Yes, I agree @alexkrolick. Perhaps the left could be "label text" "placeholder text" "text content" etc. etc. and then on each page we show a snippet of the available variations or something? With a summary page that shows the differences?

[gregtatum]

That makes sense. I generally prefer explicitness over terseness. This is horribly styled but I was also thinking of something like this:

It has the benefits of being searchable.