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

docs(carbon-react): add README and initial sass config docs #8586

Merged

Conversation

joshblack
Copy link
Contributor

Closes #8558

This PR adds in our initial README and sass doc for our beta release next week. The goal with this work is to provide the minimal documentation needed for teams to get started with:

  • Including components
  • Including icons
  • Including styles

It's also a chance for our team to see the new package architecture and see how it fits in with our plans moving forward 👀

Changelog

New

  • Add README for @carbon/react
  • Add initial docs for sass configuration for @carbon/react

Changed

  • Add sass as a peer dependency for @carbon/react

Removed

Testing / Reviewing

  • Read through the README / Sass configuration docs to see if they make sense
  • Take a look at the new package architecture (one package versus several) for bringing in parts of our design system and see if it makes sense to you / is it the right call for our team

@joshblack joshblack requested a review from tay1orjones May 5, 2021 17:11
@joshblack joshblack requested a review from a team as a code owner May 5, 2021 17:11
@joshblack joshblack requested review from emyarod and tw15egan May 5, 2021 17:11
@netlify
Copy link

netlify bot commented May 5, 2021

Deploy preview for carbon-elements ready!

Built with commit 15280a5

https://deploy-preview-8586--carbon-elements.netlify.app

@netlify
Copy link

netlify bot commented May 5, 2021

Deploy preview for carbon-components-react ready!

Built with commit 15280a5

https://deploy-preview-8586--carbon-components-react.netlify.app

Copy link
Member

@tay1orjones tay1orjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple things that stuck out, but overall looks great to me!

packages/carbon-react/README.md Outdated Show resolved Hide resolved
packages/carbon-react/README.md Outdated Show resolved Hide resolved
packages/carbon-react/README.md Outdated Show resolved Hide resolved
packages/carbon-react/README.md Outdated Show resolved Hide resolved
packages/carbon-react/README.md Outdated Show resolved Hide resolved
packages/carbon-react/docs/sass.md Show resolved Hide resolved
packages/carbon-react/package.json Outdated Show resolved Hide resolved
joshblack and others added 7 commits May 5, 2021 14:52
Copy link
Member

@tay1orjones tay1orjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! 🎉

Copy link
Member

@tw15egan tw15egan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Just a few comments

packages/carbon-react/README.md Show resolved Hide resolved
packages/carbon-react/README.md Show resolved Hide resolved
@joshblack joshblack merged commit c75a170 into carbon-design-system:main May 5, 2021
@joshblack joshblack deleted the docs/add-carbon-react-readme branch May 5, 2021 22:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add initial README for @carbon/react
3 participants