Skip to content

Commit 9e347cb

Browse files
refactor: after review
1 parent 2a24bb4 commit 9e347cb

File tree

3 files changed

+3
-6
lines changed

3 files changed

+3
-6
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,8 +316,7 @@ If your component requires additional styling (which most likely is the case), e
316316
component's directory `/src/MyComponent/index.scss` which by default contains an empty class for your component.
317317

318318
If you wish to use CSS variables (which is the preferred way of styling the components since values can be
319-
easily overridden and customized by the consumers of Paragon), create specific design tokens in `tokens` directory (in the `core` and `themes` directories) and then generate (`npm run build-tokens`) CSS variables for your component.
320-
This way the variables will also get automatically picked up by documentation site and displayed on your component's page.
319+
easily overridden and customized by the consumers of Paragon), you can do so by utilizing [design tokens](/tokens).
321320

322321
**Please note that you need to follow [Paragon's CSS styling conventions](docs/decisions/0012-css-styling-conventions).**
323322

tokens/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Design Tokens
22

3-
This module is responsible for handling design tokens in Paragon, for rationale behind design tokens see [Scaling Paragon's styles architecture with design tokens](https://openedx.atlassian.net/wiki/spaces/BPL/pages/3630923811/Scaling+Paragon+s+styles+architecture+with+design+tokens)
4-
and relevant ADR(TODO: add link when we merge an ADR).
3+
This module is responsible for handling design tokens in Paragon, for rationale behind design tokens see [Scaling Paragon's styles architecture with design tokens](https://openedx.atlassian.net/wiki/spaces/BPL/pages/3630923811/Scaling+Paragon+s+styles+architecture+with+design+tokens).
54

65
## Overview
76

www/src/pages/tools/component-generator.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,7 @@ If your component requires additional styling (which most likely is the case), e
7272
component's directory `/src/MyComponent/index.scss` which by default contains an empty class for your component.
7373

7474
If you wish to use CSS variables (which is the preferred way of styling the components since values can be
75-
easily overridden and customized by the consumers of Paragon), create specific design tokens in `tokens` directory (in the `core` and `themes` directories) and then generate (`npm run build-tokens`) CSS variables for your component.
76-
This way the variables will also get automatically picked up by documentation site and displayed on your component's page.
75+
easily overridden and customized by the consumers of Paragon), you can do so by utilizing [design tokens](/tokens).
7776

7877
**Please note that you need to follow [Paragon's CSS styling conventions](https://github.com/openedx/paragon/blob/master/docs/decisions/0012-css-styling-conventions).**
7978

0 commit comments

Comments
 (0)