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

Write initial usage docs for @carbon/styles #9169

Closed
5 tasks
Tracked by #9162
joshblack opened this issue Jul 12, 2021 · 0 comments
Closed
5 tasks
Tracked by #9162

Write initial usage docs for @carbon/styles #9169

joshblack opened this issue Jul 12, 2021 · 0 comments
Assignees
Milestone

Comments

@joshblack
Copy link
Contributor

joshblack commented Jul 12, 2021

This issue is for writing out the initial usage docs for the @carbon/styles package. These usage docs should include:

  • How to bring in the package and use the styles
  • How to bring in individual component styles
  • How to change the theme
  • How to use design tokens (overlap with Design Tokens)
  • How to bring in IBM Plex to your project

These docs should be present in the README.md and docs/sass.md files in the packages/styles folder. The README.md should contain high-level, common information and the docs/sass.md file will be comprehensive/contain all information.

In other words, README.md should contain high-level usage/examples. docs/sass.md should contain detailed API information

@joshblack joshblack mentioned this issue Jul 12, 2021
9 tasks
@joshblack joshblack changed the title Write initial usage docs for , these docs should include: Write initial usage docs for @carbon/styles Jul 12, 2021
@mattrosno mattrosno added this to the v11 Beta 1 milestone Jul 12, 2021
@joshblack joshblack self-assigned this Jul 21, 2021
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