Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request]: Improve published documentation #405

Open
1 task done
lee-chase opened this issue Feb 3, 2025 · 1 comment
Open
1 task done

[Feature Request]: Improve published documentation #405

lee-chase opened this issue Feb 3, 2025 · 1 comment

Comments

@lee-chase
Copy link
Member

lee-chase commented Feb 3, 2025

The problem

Having clicked through a few @Carbon-Labs components on npm I can see no README files. In addition the homepage and repository both point at the Carbon Labs mono repo. This leaves users with no information as to what the component is, how to use the component or even what @Carbon-Labs is.

The solution

  • Add README files to all components
  • Change the home page to point towards the components source code folder.

Examples

https://github.com/carbon-design-system/carbon-labs

Application/Product

N/A

Business priority

None

Available extra resources

No response

Code of Conduct

@kennylam
Copy link
Member

kennylam commented Feb 4, 2025

Good suggestion from @sstrubberg for component-specific docs (should be responsibility of component contributor):

  • Make a Readme template that a Labs contributor can easily bring into their project
  • It should provide what it is/does, who the maintainer is, what status is it, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants