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(styles): add sass.md docs and README docs #9207

Conversation

joshblack
Copy link
Contributor

@joshblack joshblack commented Jul 15, 2021

Closes #9178

This PR is a documentation PR for:

  • Updating the README for @carbon/styles
  • Providing documentation on how to use tokens from the package
  • Providing documentation on how to use component tokens from the package

It also includes a skeleton docs/sass.md file for describing additional entry points in the future

Changelog

New

  • Add docs/sass.md for styles

Changed

  • Update README for styles

Removed

Testing / Reviewing

  • Read through the packages/styles/README.md file and see if it makes sense to you and is accurate
  • Read through the docs available in packages/styles/docs/sass.md and see if it makes sense to you and is accurate

@netlify
Copy link

netlify bot commented Jul 15, 2021

✔️ Deploy Preview for carbon-react-next ready!

🔨 Explore the source changes: aa416a3

🔍 Inspect the deploy log: https://app.netlify.com/sites/carbon-react-next/deploys/60f5c0756bdb200008683b9d

😎 Browse the preview: https://deploy-preview-9207--carbon-react-next.netlify.app

@netlify
Copy link

netlify bot commented Jul 15, 2021

✔️ Deploy Preview for carbon-elements ready!

🔨 Explore the source changes: c559e23

🔍 Inspect the deploy log: https://app.netlify.com/sites/carbon-elements/deploys/60f04d01d3130e0007ef2ae0

😎 Browse the preview: https://deploy-preview-9207--carbon-elements.netlify.app

@netlify
Copy link

netlify bot commented Jul 15, 2021

✔️ Deploy Preview for carbon-components-react ready!

🔨 Explore the source changes: c559e23

🔍 Inspect the deploy log: https://app.netlify.com/sites/carbon-components-react/deploys/60f04d01b05cdd00075de2c8

😎 Browse the preview: https://deploy-preview-9207--carbon-components-react.netlify.app

@netlify
Copy link

netlify bot commented Jul 15, 2021

✔️ Deploy Preview for carbon-elements ready!

🔨 Explore the source changes: aa416a3

🔍 Inspect the deploy log: https://app.netlify.com/sites/carbon-elements/deploys/60f5c07555e16900081e51ce

😎 Browse the preview: https://deploy-preview-9207--carbon-elements.netlify.app

@netlify
Copy link

netlify bot commented Jul 15, 2021

✔️ Deploy Preview for carbon-components-react ready!
Built without sensitive environment variables

🔨 Explore the source changes: aa416a3

🔍 Inspect the deploy log: https://app.netlify.com/sites/carbon-components-react/deploys/60f5c075afb4960007a95287

😎 Browse the preview: https://deploy-preview-9207--carbon-components-react.netlify.app

@joshblack joshblack marked this pull request as ready for review July 16, 2021 16:20
@joshblack joshblack requested a review from a team as a code owner July 16, 2021 16:20
Copy link
Member

@sstrubberg sstrubberg left a comment

Choose a reason for hiding this comment

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

This is great. I want to use these docs to upgrade the tutorial and record my process. I'll report back anything that goes off the rails.

Copy link
Contributor

@andreancardona andreancardona left a comment

Choose a reason for hiding this comment

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

🎉

@andreancardona andreancardona merged commit f837fbc into carbon-design-system:main Jul 19, 2021
@joshblack joshblack deleted the 9178-add-css-custom-property-usage branch July 20, 2021 14:02
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 usage docs for high-level API like CSS Custom Properties
3 participants