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

Question

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

SebConejo opened this issue 4 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.

Answer 1 · 2024-09-23T12:42:17.000Z

@SebConejo Hi SebConejo I am happy to contribute to this issue and solve it, could i

Answer 2 · 2024-09-23T14:20:03.000Z

Hi @LoayTarek5. I assigned you to the issue 👍

Answer 3 · 2024-09-23T14:31:03.000Z

@SebConejo should I solve it and merge at beginning Hacktoberfest or is it ok to pull/merge now

Answer 4 · 2024-09-23T14:40:08.000Z

@LoayTarek5 If the work is ready and doesn't need to be tied to Hacktoberfest, you can do it now. We will review it this week. If your goal is to "earn points" during Hacktoberfest, you have to wait for October 1st before making a PR.

Answer 5 · 2024-09-23T14:54:57.000Z

@SebConejo Oh, I am sorry. By mistake I removed myself, could you assign it to me again. Anyway, I will work on this issue now.

Answer 6 · 2024-09-24T07:37:23.000Z

@SebConejo Sorry, I couldn't find the file I need to edit to fix the style. Can you please tell me which file to edit?

Answer 7 · 2024-09-25T07:35:38.000Z

@SebConejo Sorry, I couldn't find the file I need to edit to fix the style. Can you please tell me which file to edit?

@LoayTarek5 The file is this one: packages\core\manifest\src\main.ts

We use swaggerUI for now. The css is writtten directly in this typescript file.

Answer 8 · 2024-09-25T15:06:08.000Z

@SebConejo Is it good?

Answer 9 · 2024-09-26T07:52:47.000Z

@LoayTarek5 Thank you for your proposal. Here are my comments:

Could you use this blue instead: #2430F0 ? Or this one if you think it's easier to read: #1eb1e8. Those blues are in the toolkit.
The change should only be made to h4. Not on response headers, response bodies. You see what I mean?

Answer 10 · 2024-09-26T08:12:11.000Z

@SebConejo ok i will use #1eb1e8 i think it is better
Is this how it should look?

or you want only edit on this :