1 of 10

Proposed changes to�Paragon project structure�And theming for MFEs

2 of 10

Today

3 of 10

4 of 10

Benefits

  • The edX theme is represented in the doc site with little technical complexity
  • edX theme changes are easily seen during development

Drawbacks

  • edX theme changes are coupled with Paragon component changes. (This can block teams from upgrading the edX theme in their projects)
  • The default theme is not represented in documentation

5 of 10

Proposed

6 of 10

7 of 10

Benefits

  • The edX theme is decoupled from Paragon. Adopting theme updates is easier for teams.
  • The default and edX themes are both documented.
  • There is a new common location for brand assets.
  • Paragon is a truly independent open source library

Drawbacks

  • Two documentation sites one for edX and one for Paragon makes for additional complexity.
  • edX theme changes may be more difficult to see during development

8 of 10

Theming Open edX

9 of 10

10 of 10

What this does

A standard set of brand elements (logos) are used across Open edX projects. A Paragon SCSS theme (bootstrap conformant) can be applied to both MFEs and edx-platform.

What this does not do

This does not solve for pluggable components in MFEs.

Solve all SCSS theming needs in edx-platform. Edx-platform themes should include the aliased @edx/brand SCSS theme and Paragon core SCSS just as they do with Bootstrap today.

Note: A CSS in JS system may be added to the theming interface in the future.

​