carbon-design-system / carbon-design-system/carbon-components-angular
More user-friendly documentation
- Dominant language
- TypeScript
- Stars
- 566
- Forks
- 318
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
Research direction
Start with the Modal documentation entry point at angular.carbondesignsystem.com/?path=/story/components-modal--documentation, then compare its setup and usage guidance with the ngx-bootstrap and Angular Material modal documentation linked in the issue. Done means the documentation is substantially more compact and clearly explains how a new user can get a simple modal working.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, typescript
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100