mui-design-kits icon indicating copy to clipboard operation
mui-design-kits copied to clipboard

[figma] Add documentation

Open oliviertassinari opened this issue 3 years ago • 3 comments

Introduction

We could create dedicated documentation under https://mui.com/figma/getting-started/. For now, it's a redirection to https://mui.com/material-ui/design-resources/material-ui-for-figma/ but this should be owned in this repository. Figma is a distraction for the components team.

Benchmark

  • https://www.antforfigma.com/docs/introduction

Problems it would solve

  • Showcasing all the features of the kit, e.g. https://mui.zendesk.com/agent/tickets/11801.
  • Tons of Zendesk tickets: https://www.notion.so/mui-org/MUI-Design-Kits-FAQ-b729d8b48f5a45529319a92656cad41f

oliviertassinari avatar Oct 16 '21 17:10 oliviertassinari

"How to migrate from Design to React?", it is advised here to use the design tokens from the system in MUI as much as possible and update those to keep designers and developers in sync.

I think this is a great idea, but currently the documentation on the theme shape and the default values are very developer focused. It would be great to have a designer friendly resource to link to designers so that they can grok the theming system in MUI and apply it when using the accompanying style library (like figma).

Nicktho avatar Oct 28 '21 04:10 Nicktho

@Nicktho Do you have one small but concrete change example that we could do? (I fail to envision how we can put this in practice).

oliviertassinari avatar Oct 28 '21 14:10 oliviertassinari

@Nicktho Do you have one small but concrete change example that we could do? (I fail to envision how we can put this in practice).

I'm working on a video series when I have some spare time (when I'm not working on the library) which is focused on the specific questions @Nicktho asked. After this upcoming Figma release, I'll dedicate my time fully to this task.

So far I'm working on the scripts for:

  • How can we edit components?
  • How to customize colors?
  • How to handle Figma updates?
  • Designing an app with MUI for Figma

If you have suggestions please let me know in this thread.

adrianmanea avatar Dec 17 '21 09:12 adrianmanea