[Feature Request] Improved Documentation

[ccrvlh]

Hi guys. We are looking at a design system to use on our own application. You've done some amazing work with Colloid, and since we already use Ant, we are thinking that maybe the switch costs won't be too high. One thing we were concerned about is the lack of documentation. So I was wondering what are the plans for the system in the future, whether there will be some effort on improving the docs in the future, or this will stay on "as is" basis. Anyways, amazing library, can't thank you guys enough for open sourcing it. Cheers!

[snrs-art]

Dear @lowercase00,

thank you for your time and patience. We would like to let you know that we have initial plans for improving our design system's documentation as we are aware of this that it definitely requires more focus from our side. Unfortunately it is going to take some time until it is really helpful for external people, so I what I could suggest is that that while we are still working on the docs, if only possible, you could tell us how you would be using synerise-design. This could make possible maybe finding some way of supporting you in learning what you might be willing to use (and how) in the first place. Not to mention that most probably we would put more focus on documenting (better) components you would be especially interested in. I would like also to let you know that during the upcoming months we are planning to put more time in building the community around our design system, what also would even allow community members to have a chance to suggest additional components and/or build/implement new components as well as have them released as a part of our community's colloid.

Yours faithfully Design System Team at Synerise

[ccrvlh]

Hi @snrs-art, thanks for the response. I guess the first thing would be to have updated repo/storybook. Even without documentation, most of the time it is possible to handle things only with those two, but inconsistencies are a killer (example of the issue regarding the appMenu prop on the Layout component), and end up being a deal breaker most of the time, specially when there's will from the community to help (this is the case). I wouldn't mind new components for now, the library is pretty complete... Layout for us is crucial, and in the first try it turned to have a bug, so this would be a great start. Anyways, amazing work you guys have done so far. Thanks a lot for sharing! Cheers