Documentation for the library

[snehilvj]

Hi
I'm starting this thread as I need some help from the community in creating the documentation for the library.

I have started a project dmc-demo for this, and its deployed here. The latest version that's been released is 0.2.1, but before I move on with further releases, I'd like to work on the documentation, without which, people can obviously not use it properly.

I am already looking at the docs for official dash components and the docs for dash bootstrap components.

If anyone has any suggestions for the docs or some resources I can use, or some pointers for starting out, please do provide them.

Thanks

@emilhe @Karan-S-Mittal

[emilhe]

I was faced with similar considerations, when I wrote the dash-leaflet docs. I ended up just creating a Dash app using bootstrap, but I am curios to know about other (better?) options. It's actually on my TODO list to try reimplementing the dash-leaflet docs using mantine components :)

[Karan-S-Mittal]

It's my first time writing Docs for the application. I would like to propose an idea, that we can develop docs similar to Dash-docs, where we can showcase components alongside their multiple use-cases.
🙂 @emilhe, I am a big fan of your work and am so glad to be part of this conversation.

[snehilvj]

yeah, I had similar thoughts about this. I have been working on a draft, here it is. Please let me know your feedback. Its entirely a dash app made obviously with mantine components.

dmc-docs.mp4

[snehilvj]

I have released a new version of the dmc library: 0.2.2, and the new docs.
Closing this issue now. Docs related things can be discussed in its own repo: dmc-docs.

[emilhe]

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