Usability nightmare in new REST API doc website

Let’s talk about usability in https://docs.github.com/en/rest/reference the REST API new home

The usability is IMHO a nightmare.

  1. API Response specs are an essential part of API doc and are hidden by default, need to click for folding out.
  2. Browser search does not find anything in API response specs, unless I click and open the respective part.

Steps to reproduce:

  1. Go to https://docs.github.com/en/rest/reference/users
  2. Use browser search to find term “avatar_url”
  3. No result
  4. Click to open “default response” on any of the API sections
  5. Retry search
  6. Find expected results
1 Like

The Webhook events and payloads serves as an example how to solve it.

Hi @stmllr welcome back to the community, thank you for taking the time to provide this feedback. I’ve passed it along to our docs team, and they have opened an issue to discuss the change. Thanks for your patience, as soon as I see an update on the issue I’ll post an update here :+1:

Hi @stmllr, I wanted to let you know we have a fix on the way! Will post back once is deployed.