This repository has been archived by the owner on Mar 8, 2023. It is now read-only.
[Component README]: Update documentation to include component markup examples #755
Closed
2 tasks done
Labels
dev
Needs some dev work
documentation
Improvements or additions to documentation
Feature request
A new adopter requested feature
package: carbon web components
priority: medium
Milestone
The problem
The current READMEs for each of the components do no include markup examples on how to utilize the components. In addition, the canvas component does not seem to provide any value since the storybook canvas itself can be the preview of it:
https://web-components.carbondesignsystem.com/?path=/docs/components-accordion--default
In comparison, the
Carbon for IBM.com
READMEs include details on how to implement, including how to use CDN vs ES approach:https://www.ibm.com/standards/carbon/web-components/?path=/docs/components-card-group--default
The solution
Update the component READMEs to include implementation guidelines, sample code, and remove the canvas component.
Application/website
Carbon Web Components
Business priority
Medium Priority = upcoming release but is not pressing
What time frame would this ideally be needed by (if applicable)
No response
Examples
Carbon for IBM.com Web components storybook:
https://www.ibm.com/standards/carbon/web-components
Code of Conduct
The text was updated successfully, but these errors were encountered: