Name change

[WilliamKelley]

"Spark" is on the way out, and generic is on the way in. This post is for discussion and planning around moving from "Prenda Spark Design System" to "Prenda Design System" (tentative name).

I will start off with tasks I think are necessary and update it according to feedback from further discussion below.

Tasks

• Change repository name
  • prenda-school/prenda-spark -> prenda-school/design-system
    • "prenda" doesn't need to appear twice, it's clear that Prenda owns the repo already
    • "design system" is generic enough to include all pursuits, current and future
• New package names
  • @prenda/design-core
    • Not to be installed by consumers, only by other @prenda/design-* packages.
    • Background: with the advent of micro-frontends ({WIP} Use in Micro Frontends #222) in Prenda and the power for teams to choose their own implementation details, it's foreseeable that a team wants to use something other than React. While the implementation won't be there until the team works on it, we should at least give it a thoughtful place to happen.
    • Purpose: define things universal to all design implementations (language / library / framework independent)
      • Centralizes the changing of these values, rather than having n updates for every implementation.
    • What: JS and CSS module exports of "foundational" values: color, typography, etc.
  • @prenda/design-react: replaces @prenda/spark
  • @prenda/design-react-icons: replaces @prenda/spark-icons
  • Each new package will start at v0.0.1
  • Each new package corresponds to a new project folder under libs/.
    • (existing folders will continue to live there just under maintenance-only, and then obsolescence)
• Update README's
  • remove instances of "Spark"
  • explain new paradigm
  • explain existence of old paradigm.
  • where reasonable, "Spark" stuff can be moved to libs/spark/README.md for archival purposes.
• Mark @prenda/spark and @prenda/spark-icons as deprecated, maintenance-only, and planned for obsolence with v1.0.0 release of @prenda/design-react.

Timing and communication

• Coincide with development of upgrade to Mui v5.
  • Why? This is a significant step that will take reading and understanding time for every consumer. So, it should be timed together with any other major steps so that a consumer can "take the time" all-at-once.