manifest icon indicating copy to clipboard operation
manifest copied to clipboard

style: Update the look and feel of the `responses` title on the API docs to make it easier to read

Open SebConejo opened this issue 7 months ago • 10 comments

The structure of the API documentation is difficult to follow.

When testing an endpoint, the API documentation first displays the test response, followed by a list of possible responses. Both sections have titles, but these titles are not very prominent. They are written in small text with minimal whitespace above them, making them hard to notice. The separation between these two sections could be improved.


My suggestions:

  • [ ] Increase the white space above the title.
  • [ ] If it's not enough visible, try to use a different color, or add a separator line, or even try adding emojis.

Remarks

  • It looks unnecessary to increase the font size as the parent title is small too.

Capture d’écran 2024-08-30 à 10 45 51

Capture d’écran 2024-09-23 à 14 34 59

SebConejo avatar Aug 01 '24 12:08 SebConejo