Skip to content

Commit

Permalink
[docs] Move feedback from Canny to GitHub
Browse files Browse the repository at this point in the history
One step toward closing mui/mui-design-kits#358.
  • Loading branch information
oliviertassinari committed Jul 16, 2024
1 parent 19c1935 commit 1383239
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## Getting started

Material UI for Figma consists of representations of the library's React components in Figma so designers and developers can communicate and iterate more efficiently.
The kit includes:
This Design Kit includes:

- components with the same design as Material UI
- additional components and features not covered by Material Design
Expand Down Expand Up @@ -81,7 +81,7 @@ The video below shows how to add new columns by copying cells directly on the ma

<iframe width="100%" height="490" src="https://www.youtube.com/embed/s_n3LHm1daI?si=_QbXvtYPkc8EBd5d" title="YouTube video player" frameborder="0" allowfullscreen></iframe>

## Code sync
## Code sync (beta)

You can export theme tokens and component customizations to code using [the Sync plugin for Figma](/material-ui/design-resources/material-ui-sync/).
The Design Kit has been built to be as close to the React components as possible, making it for a fluid integration with code.
Expand All @@ -96,3 +96,7 @@ If you need to replace a single component that's been updated, there are a coupl
1. Add the new version of the design kit as a library and use [the new Figma library swap feature](https://www.youtube.com/watch?v=GQ2jztKpxLk). The components must have the same names in both libraries.
2. Observe the new component and re-apply the changes to the existing projects. This is the recommended approach when you need to update multiple projects.
3. Copy and paste the new component into your existing project, give it a different temporary name, then re-link tokens to the new component. When using [Select Similar plugins](https://www.figma.com/community/plugin/792767780551514994/select-similar) this shouldn't take more than five minutes. Then you can remove the old component and update the new component name.

## Feedback and bug reports

If you've got any feedback, we'd love to [hear from you](https://github.com/mui/mui-design-kits/discussions/84).
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Other kits, such as the Joy UI Design Kit, are not supported yet.

If you don't have the [complete and latest version](/store/items/figma-react/) of the Material UI for Figma Design Kit installed, you can test the plugin by using the [Community version](https://www.figma.com/community/file/912837788133317724/material-ui-for-figma-and-mui-x) instead.

After installing and opening it in Figma, head over to the [Material UI Sync plugin page](https://www.figma.com/community/plugin/1336346114713490235/material-ui-sync) on the Community tab and click on **Open in...** and select the Material UI for Figma Design Kit.
After installing and opening it in Figma, head over to the [Material UI Sync plugin page](https://www.figma.com/community/plugin/1336346114713490235/material-ui-sync) on the Community tab and click on **Open in** and select the Material UI for Figma Design Kit.

<img src="/static/material-ui/design-resources/sync-access.png" style="width: 814px;" alt="Accessing Material UI Sync via the Resources menu in Figma." width="1628" height="400" />

Expand Down Expand Up @@ -294,4 +294,4 @@ export default function MyApp({ Component, pageProps }) {

## Feedback and bug reports

Use [the dedicated Material UI Sync feedback board](https://material-ui-sync.canny.io/) to share feedback, report bugs, or drop feature requests.
If you've got any feedback, we'd love to [hear from you](https://github.com/mui/mui-design-kits/discussions/84).
4 changes: 2 additions & 2 deletions docs/pages/blog/introducing-sync-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@ The Material UI Sync plugin also bakes in an embedded Storybook preview panel s

## Try Sync now

Get the beta version of Material UI Sync now, available for free in the [Figma Community](https://www.figma.com/community/plugin/1336346114713490235/material-ui-sync)!
Get the beta version of Material UI Sync now, available to try for free in the [Figma Community](https://www.figma.com/community/plugin/1336346114713490235/material-ui-sync)!

There's still a lot to do, and we're looking forward to hearing from all of you [who requested this plugin years ago](https://github.com/mui/mui-design-kits/issues/10).

- Check out the documentation for [the Sync plugin](/material-ui/design-resources/material-ui-sync/) and [the Material UI Design Kit](/material-ui/design-resources/material-ui-for-figma/).
- If you've got any feedback, we'd love to [hear from you](https://material-ui-sync.canny.io/).
- If you've got any feedback, we'd love to [hear from you](https://github.com/mui/mui-design-kits/discussions/84).

Happy designing! 👨‍🎨

0 comments on commit 1383239

Please sign in to comment.