Skip to content

Commit

Permalink
Fix the docs (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
NoriSte authored Mar 9, 2024
1 parent 17a97a2 commit 444a0f4
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 49 deletions.
43 changes: 0 additions & 43 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,12 @@
# Contributing

TODO:

## Issues

If you want to raise an issue:
1. Please check the [README's roadmap](./README.md#roadmap) in advance, chances are we already
planned to work on what you need
1. Please check the [README's FAQ](./README.md#faq) in advance, chances are we are aware of your
needs but we chose not to work on them

## Features

First of all, open an issue to describe the feature you would like to build. This helps to avoid you
wasting your time in case something is not needed or we have a different vision about the topic 😊

## Development

### How the plugin works

If you start from [src/types.ts](./src/types.ts), and [src/main.ts](./src/main.ts) files, you can
see the plugin is split in two big steps:

1. A **traverser**: it goes through the content of the Figma document looking for all the useful
elements which influence the generated state machine (for instance: fragments, buttons, etc.). The
goal is to generate a **Figma-agnostic object descriptor** used later on to generate the state
machine. The object created by the traverser is logged in the console's devtools.

1. Some **generators**: they generate the state machine's code out of the Figma-agnostic object
descriptor. The generate machine is a string to be then copy-pasted in your own project, or in the
XState visualizer. In the future, more generators will be added.

### Tests

At the moment:
1. The traverser is not tested
2. The generators are unit tested
1. Anyway, only the generated string is checked. At the moment, the string is not used to create
a real XState state machine


### To do list

Here is an non-exhausting list of things to do on the project, prioritize by importance.

1. Cover more Figma's features (see the main [README](./README.md))
2. Set up automatic releases
3. Add documentation for how the supported Figma entities and interactions are then converted to the
state machine


## Development guide

*This plugin is built with [Create Figma Plugin](https://yuanqing.github.io/create-figma-plugin/).*
Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ This plugin aims to solve this problem by making logging as easy as possible!

Because the properties must be added to the UI by the plugin's author, limiting the plugin's scalability (as you can see in the reviews).

<!-- ### Install the plugin
## Install the plugin

TODO: update this guide, for figma to xstate too.
1. In the Figma desktop app, open a Figma document.
2. Search for and run `Import plugin from manifest…` via the Quick Actions search bar.
3. Select the `manifest.json` file that was generated by the `build` script. -->
Refer to [the dedicated Figma Community page](https://www.figma.com/community/plugin/1348339696557868933/select-and-inspect).

0 comments on commit 444a0f4

Please sign in to comment.