Design tokens: What's left

Owned by Adam Stankiewicz
Oct 18, 2023
2 min read

Related docs:

Open PRs

Paragon

CLI

https://github.com/openedx/paragon/pull/2609

https://github.com/openedx/paragon/pull/2617

@edx/frontend-platform

https://github.com/openedx/frontend-platform/pull/440

https://github.com/openedx/frontend-platform/pull/534

Related: https://github.com/openedx/frontend-platform/pull/351

@edx/frontend-build

https://github.com/openedx/frontend-build/pull/365

@edx/brand-openedx

https://github.com/openedx/brand-openedx/pull/16

@edx/brand-edx.org

https://github.com/edx/brand-edx.org/pull/75

Shared UI components

Header

https://github.com/openedx/frontend-component-header/pull/351

https://github.com/edx/frontend-component-header-edx/pull/393

Footer

https://github.com/openedx/frontend-component-footer/pull/303

https://github.com/edx/frontend-component-footer-edx/pull/294

Open Issues

https://github.com/openedx/paragon/issues/2688

https://github.com/openedx/paragon/issues/2672

https://github.com/openedx/paragon/issues/2526

https://github.com/openedx/paragon/issues/2520

https://github.com/openedx/paragon/issues/2269

[This scope could also be expanded to include a beta version, if we’re opting to go that route.]

https://github.com/openedx/paragon/issues/2470

[This is not a prerequisite for design tokens release for the web-based UIs. It is an interesting discussion/opportunity to share style properties between web and native mobile platforms, though.]

https://github.com/openedx/paragon/issues/2025

[This is likely not a prerequisite for release, but may be worth considering.]

https://github.com/openedx/paragon/issues/1778

https://github.com/openedx/paragon/issues/1546

[This includes: (1) finding any other places in existing docs site that references SCSS variables (e.g., we’ve only updated the “Colors” page thus far; needs to be replaced with CSS variables; (2) Documentation for theme authors on how to override the core design tokens and/or implement their own.]

[Not Yet Ticketed/Scoped] Would still like to try to do more nuanced performance benchmarking on the new way of ingesting Paragon’s CSS vs. how we did it before. For example, none of Paragon’s CSS will go through Webpack build compilation so tools such as PurgeCSS, etc. won’t work to reduce Paragon’s CSS asset size.

[Not Yet Ticketed/Scoped] Further QA to ensure no regressions of style properties, a11y, and/or functionality of components. I expect we will continue to find minor issues that need to be addressed.

[Not Yet Ticketed/Scoped] Discovery: expose design tokens tooling as a REST API so MFEs can do runtime theming based on dynamic, user-driven values (e.g., Enterprise theming, partner theming, etc.). Not a prerequisite for initial design tokens release.

[Not Yet Ticketed/Scoped] Supporting consumers in migrating off deprecated components, as these are removed with design tokens release.

[Not Yet Ticketed/Scoped] Supporting consumers in migrating off FontAwesome, as the remaining support for this is removed with design tokens release.

[Not Yet Ticketed/Scoped] Understand the nuances of peer dependencies to enable the design tokens release across shared components and libraries so consumers don’t get blocked on peer dependency issues to understand the appropriate sequencing of releases.

[Not Yet Ticketed/Scoped] Work with maintainers of repositories consuming Paragon (MFEs) to understand if they want to perform the upgrade themselves, or if they want an external contribution for their review. Possibly refer to Upgrade Project Runbook for guidance.