2024-08-07 Meeting notes

2 minutes

[Inform] Brand package DEPR accepted

@Brian Smith

https://github.com/openedx/brand-openedx/issues/23#issuecomment-2273542486

10-15 minutes

Design tokens docsite known issues

@Brian Smith

• https://github.com/openedx/paragon/pull/3158#issuecomment-2272627245

  • Playground not applying @edx/brand-edx.org styles. Not a blocker.

    • Long-term, we want the ability for the docs site to allow consumers to supply any theme.

• Question: Will we want a 22 version of the docsite live too once alpha merges into master?

  • Add version dropdown?

    • This could be a large lift. Middle ground could be hardcoded links to different versions.

    • Also deploy versions of the docsite that correspond with versions of Paragon available in any given named release

  • [inform] We have a deployed v2 docs site here: https://paragon-openedx-v2.netlify.app/

  • @Brian Smith will figure out the plan for moving to Axim Algolia/Netlify accounts

  • Segment?

    • @Brian Smith to look into if Axim has GA or other Segment alternatives.

      • 2U will need to share Segment key with Axim in short term if we don’t move away from Segment

5-10 minutes

Gatsby typescript docs discovery

@Brian Smith

• We currently use https://www.gatsbyjs.com/plugins/gatsby-transformer-react-docgen/

  • This uses react-docgen": "^5.4.3 https://github.com/gatsbyjs/gatsby/blob/33f18ba7a98780a887d33e72936da57a6c58932a/packages/gatsby-transformer-react-docgen/package.json#L15

  • react-docgen v6 and v7 have typescript support https://react-docgen.dev/docs/release-notes/react-docgen

• Custom resolver? https://www.gatsbyjs.com/plugins/gatsby-transformer-react-docgen/#usage

• Initial thoughts

  • Ideally gatsby-transformer-react-docgen can be updated to natively support typescript props by updating the underlying react-docgen dep

    • No current issues/PRs related to upgrading react-docgen in gatsby repo.

  • In the meantime is it possible to use https://www.gatsbyjs.com/plugins/gatsby-source-typedoc/ as part of a custom resolver?

• @Brian Smith to do timeboxed discovery on custom resolvers

  • if it’s a quick win do that for now

  • if it’s not a quick win - look into PRing an update upstream to gatsby-transformer-react-docgen

@Brian Smith to make new meeting in Axim org

5 minutes

Figma reference for Open edX theme

@Glib Glugovskiy

Question about Open edX Paragon Figma Version

• The current Figma file from paragon docs site is styled with @edx/brand-edx.org theme, not @openedx/brand-openedx (2U-specific)

  • At 2U, edx.org is now using a different Figma library using @edx/elm-theme.

• Are there any plans for creating Figma library compatible with the default Paragon theme?

  • Discussion about this in the UI/UX working group coming up.

  • Goal is to have shared Figma.

  • [open question] Will the Figma library have support for theme variants?

• [long term] would be great for Figma to integrate with implemented code (e.g., color changes in GitHub repo should sync with Figma library, and possibly vice-versa).

5 minutes

Different Open edX themes support

@Glib Glugovskiy

Different design token theme examples (dark, color pallete, etc)

• Currently, the Paragon design only supports light theme variant.

• Is the design tokens project include scope of creating these additional theme variants?

  • No. Only the support for the theme variants is implemented, but not the theme variants themselves.

• Should there be documentation / examples on how consumers/instances could extend the default light Paragon theme variant?

  • How do we document this without creating a full-blown theme variant in Paragon itself?

  • The intent (initially) would largely be illustrative only.