Skip to content

Commit 80db25f

Browse files
update docs
1 parent 90490b4 commit 80db25f

File tree

3 files changed

+31
-27
lines changed

3 files changed

+31
-27
lines changed

figma/CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# Contributing to assistant figma platform
22

33
## Setting up Env vars (.env)
4+
45
> In most case, you won't have to specify contents or create `figma/.env` file.
56
67
**Variables**
7-
- `FIGMA_PERSONAL_ACCESS_TOKEN` - (Optional) For using figma developer tools.
8-
- `BRIDGED_FIRST_PARTY_APP_TOTP_SECRET` - (Not Required) Used for communicating with bridged first party cloud services. set this as "s1v1-assistant-development". learn more at [base's security startegy](https://github.com/bridgedxyz/base/blob/main/docs/security.md)
98

9+
- `FIGMA_PERSONAL_ACCESS_TOKEN` - (Optional) For using figma developer tools.
10+
- `BRIDGED_FIRST_PARTY_APP_TOTP_SECRET` - (Not Required) Used for communicating with bridged first party cloud services. set this as "s1v1-assistant-development". learn more at [base's security startegy](https://github.com/gridaco/base/blob/main/docs/security.md)
1011

1112
## Good to know - Somethings leart from mistakes
1213

figma/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,15 @@
1616

1717
First:
1818

19-
```
19+
```sh
2020
$ yarn install
21-
```
2221

23-
```
24-
$ yarn run dev
22+
# building for production - this will load production web hosted version in your plugin host
23+
$ yarn run build
24+
25+
# building for development - this will load localhost:3000/init-figma page in to your plugin host
26+
$ yarn run build:dev
27+
$ yarn run watch # same as `build:dev`, but in watch mode. (if you are not interacting with figma-core, you don't have to run this command.)
2528
```
2629

2730
### Installing the plugin

xd/README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
1-
# Bridged Assistant on Adobe XD
2-
3-
1+
# Grida Assistant on Adobe XD
42

53
## references
6-
xd plugin react [example](https://github.com/AdobeXD/plugin-samples/tree/master/quick-start-react)
74

5+
xd plugin react [example](https://github.com/AdobeXD/plugin-samples/tree/master/quick-start-react)
86

97
[get UXP developer tools](https://www.adobe.io/photoshop/uxp/devtool/)
108

11-
129
[XD plugin api docs](https://adobexdplatform.com/plugin-docs/reference/xd-index.html)
1310

14-
1511
# Development
1612

1713
## Getting started
18-
* One time: Install nodejs (https://nodejs.org/en/download/) and yarn (npm i yarn -g)
19-
* Open terminal and navigate to the /xd-flutter-plugin-src folder
20-
* run `yarn`
21-
* run `yarn build`
22-
* Plugin files will be copied into the /build folder, and also into your XD plugin developer folder
23-
* Refresh plugin in XD with `Ctrl+Shift+R`
14+
15+
- One time: Install nodejs (https://nodejs.org/en/download/) and yarn (npm i yarn -g)
16+
- Open terminal and navigate to the /xd-flutter-plugin-src folder
17+
- run `yarn`
18+
- run `yarn build`
19+
- Plugin files will be copied into the /build folder, and also into your XD plugin developer folder
20+
- Refresh plugin in XD with `Ctrl+Shift+R`
2421

2522
## Notes
26-
* If you get errors about missing dependencies when building, you probably need to run `yarn` again
27-
* builds are run in watch mode by default, meaning webpack re-bundles on file save
23+
24+
- If you get errors about missing dependencies when building, you probably need to run `yarn` again
25+
- builds are run in watch mode by default, meaning webpack re-bundles on file save
2826
-> add `--no-watch` to disable watch mode
29-
* builds are automatically copied to the XD develop folder, use cmd/ctrl-shft-R in XD to reload plugins
27+
- builds are automatically copied to the XD develop folder, use cmd/ctrl-shft-R in XD to reload plugins
3028

3129
## Production builds
30+
3231
If you are creating production builds for publishing, there are a few other things to consider:
33-
* re-export / test the example thoroughly
34-
* in version.js: update the `version`, `xdVersionRequired`, & set `debug` to false
35-
* update the version in manifest.json, and ensure the README and CHANGELOG are up to date (incl. version) and committed.
36-
* clear the `build` folder and use `yarn build --production` to minifiy and disable sourcemaps
37-
* create the `xdx` file by zipping the _contents_ of the build folder, and renaming with a `.xdx` extension.
38-
* once the plugin is submitted, tag the commit with it's version number (ex. `v1.0.0`)
32+
33+
- re-export / test the example thoroughly
34+
- in version.js: update the `version`, `xdVersionRequired`, & set `debug` to false
35+
- update the version in manifest.json, and ensure the README and CHANGELOG are up to date (incl. version) and committed.
36+
- clear the `build` folder and use `yarn build --production` to minifiy and disable sourcemaps
37+
- create the `xdx` file by zipping the _contents_ of the build folder, and renaming with a `.xdx` extension.
38+
- once the plugin is submitted, tag the commit with it's version number (ex. `v1.0.0`)

0 commit comments

Comments
 (0)