More user-friendly documentation

[FrancescoBorzi]

Hello there, I'm trying to introduce carbon-components-angular in my project, however my team is finding the documentation a bit unfriendly.

For example, I gave it a try to the Modal:

https://angular.carbondesignsystem.com/?path=/story/components-modal--documentation

there are 313 lines of code in the documentation and it's not very clear what one should do in order to get a simple modal working. After spending some time there, I still haven't managed to get it working because of some weird errors in my console. Probably I'm still missing something.

What I'm suggesting here would be a complete rebranding of the documentation, in order to make it more compact and easier for new user to understand.

For example:

https://valor-software.com/ngx-bootstrap/#/modals

https://material.angular.io/components/dialog/overview

[cal-smith]

Hey @FrancescoBorzi 👋 this is definitely something we need to spend more time on for sure 👍

We would love to have a documentation site that it at least as good as Angular Material, but finding the time to work on it is definitely a challenge 😆

In the mean time be sure to check out our existing API documentation site (should be more complete than the storybook examples) - https://angular.carbondesignsystem.com/documentation/

For modal you'll probably want to start with https://angular.carbondesignsystem.com/documentation/components/Modal.html

We also have the Carbon Angular tutorial - https://www.carbondesignsystem.com/tutorial/angular/overview though it's in need of an update to reflect v4 and Angular 9, it should still capture the basics of working with the library.

[FrancescoBorzi]

thanks for your answer @cal-smith