wasp icon indicating copy to clipboard operation
wasp copied to clipboard

Improve readibility of API Reference blocks in new documentation

Open Martinsos opened this issue 2 years ago • 3 comments

I found it hard to scan API Reference quickly to see what is offered in the API, and to dig deeper into what I need to learn more about.

I think we should somehow emphasize top level API components (usually dict fields), so they are visually really easy to scan and pick up, and then details for each of those are something that would maybe expand, or would at least be indented one level to the right. So what I am proposing is just visual changes, changes in design, that would make API Reference more readable.

Martinsos avatar Aug 23 '23 07:08 Martinsos

I would like to work on this issue @Martinsos

ayan-joshi avatar Oct 19 '23 11:10 ayan-joshi

@ayan-joshi go for it if you want, although I am not sure how easy is this one. Shouldn't be too hard to implement, but it will require quite some attention to design / UI to properly improve the readability of API reference blocks.

Martinsos avatar Oct 19 '23 13:10 Martinsos

I like the design of NuxtUI Pro's Field component https://ui.nuxt.com/pro/components/prose/field

infomiho avatar Nov 09 '23 14:11 infomiho