carbon-website icon indicating copy to clipboard operation
carbon-website copied to clipboard

Unclear what the GitHub repository for web component is

Open rodet opened this issue 1 year ago • 1 comments

I am looking at the section for Carbon Web Components as a fresh user.

  • [ ] It is unclear what the difference is between Carbon Web Components and Carbon for IBM.com. It would be better to make it clear right away, so I don't get surprised if I land on ibm.com assets. For example, "the Carbon Web Components library is hosted by the dot.com team because it is the team that writes and owns it". Whatever a user would understand well to navigate with confidence the two spaces.
image
  • [ ] A note at the top says "Info on Carbon Web Components v1 can be found here." . It would be great to explain that WCv1 = Carbon 10, and that we are at version 2 now. I had to understand this by reading the URL after clicking on the link (especially as the line before states "This library uses Custom Elements v1 and Shadow DOM v1 specs.", this is extremely confusing.
image
  • [ ] In Troubleshooting, the GitHub repo link seems to lead to a dead branch. Again this is confusing - has it moved to a new repo, why is it a branch? Are the Carbon Web Components still hosted in the same repository currently?

rodet avatar Feb 16 '24 13:02 rodet