snehilvj/dmc-docs

Feedback on docs

emilhe opened this issue · 1 comments

Copied from issue on main repo.

I think it looks very nice! I was just about to ask for a link to code and/or a live app to get a better sense of the feel of the docs, but you beat me to it ;). The immediate things that strikes me as no-so-nice are,

  • The "Loading..." part that shows each time I click on a new component
  • Scroll bar in main panel not being mantine styled
  • Really long lines in the "Keyword Arguments" block, maybe cut at e.g. 125 characters to avoid horizontal scroll bars
  • Too much space below the "Keyword Arguments" block

Hi @emilhe thanks for all the feedback here.

The "Loading..." part that shows each time I click on a new component

Its gone now. Furthermore, I'm using /pages plugin now.

Scroll bar in main panel not being mantine styled

Way to do this is simply by using dmc.ScrollArea, but I'm having some issues with making it work properly without affecting the layout of the page. TODO.

Really long lines in the "Keyword Arguments" block, maybe cut at e.g. 125 characters to avoid horizontal scroll bars

TODO.

Too much space below the "Keyword Arguments" block

Fixed now.