You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Start here before changing skills, generator code, verification contracts, or ge
20
20
|[Generated outputs](generated-outputs.md)| Generated package matrix, build pipeline, generated-output contracts, MCP config shape, telemetry MCP tool reference, verifier expectations, and Cursor export contract. | Change or review generated files under `plugins/`, add a surface, or reason about package artifacts. |
21
21
|[Skills and integrations](skills-and-integrations.md)| Skill inventory, Studio integration concepts, MCP contracts, relationship to WordPress agent skills packaging, and safe extension boundaries. | Update shared skills, Studio guidance, or agent integration behavior. |
22
22
|[Contributor workflows](contributor-workflows.md)| Setup, commands, change recipes, manual smoke testing, CI automation contracts, and pull request checklist. | Prepare, verify, and review a repository change. |
23
-
|[Figma to WordPress](figma-playground-runner.md)| Figma plugin handoff to a WordPress Playground runner for Static Site Importer and Blocks Engine. | Review or test the Figma-to-HTML-to-WordPress integration path. |
23
+
|[Figma to WordPress Studio](figma-studio-runner.md)| Figma plugin handoff to a WordPress Studio runner for Static Site Importer and Blocks Engine. | Review or test the Figma-to-HTML-to-WordPress integration path. |
`plugins/figma-to-wordpress` moves a Figma file into WordPress. It hands the design to a WordPress runner service that creates a Playground session and imports the result with Static Site Importer and Blocks Engine.
3
+
`plugins/figma-to-wordpress-studio` moves a Figma file into WordPress. It hands the design to a WordPress runner service that creates a Studio session and imports the result with Static Site Importer and Blocks Engine.
4
4
5
5
## Architecture
6
6
@@ -9,11 +9,11 @@ Figma plugin UI
9
9
-> Figma document scene data
10
10
-> runner request
11
11
-> WordPress runner service
12
-
-> WordPress Playground session URL
12
+
-> WordPress Studio session URL
13
13
-> Static Site Importer / Blocks Engine inside WordPress
14
14
```
15
15
16
-
The TypeScript boundary stops at request construction and opening the returned Playground URL. WordPress, PHP, Static Site Importer, Blocks Engine, and Playground session orchestration remain WordPress-side runtime concerns.
16
+
The TypeScript boundary stops at request construction and opening the returned Studio URL. WordPress, PHP, Static Site Importer, Blocks Engine, and Studio session orchestration remain WordPress-side runtime concerns.
17
17
18
18
## Figma Iframe Limits
19
19
@@ -29,9 +29,9 @@ Practical constraints for this browser-based flow:
29
29
30
30
Because of those constraints, the primary integration shape is a service handoff: the plugin posts a runner request and opens the returned URL in a browser tab. If in-plugin embedding works later, it can consume the same runner response interface.
31
31
32
-
## Playground And PHP Role
32
+
## Studio And PHP Role
33
33
34
-
WordPress Playground is the correct place to run WordPress and PHP plugin logic. It provides a browser-hosted WordPress runtime backed by WebAssembly PHP and a virtual filesystem.
34
+
WordPress Studio is the correct place to run WordPress and PHP plugin logic. It provides a browser-hosted WordPress runtime backed by WebAssembly PHP and a virtual filesystem.
35
35
36
36
Static Site Importer and Blocks Engine should run in that WordPress runtime because they are WordPress/PHP import systems. The Figma plugin should not reimplement them in TypeScript. The plugin's job is to hand off design data with enough metadata for the WordPress runner to transform, install, activate, and import with those plugins.
37
37
@@ -40,32 +40,32 @@ Static Site Importer and Blocks Engine should run in that WordPress runtime beca
40
40
Implemented now:
41
41
42
42
-`GeneratedWebsiteArtifact` for static generated files from Figma.
43
-
-`figma-to-wordpress/runner-request/v1` for the runner handoff plan.
44
-
- A Figma UI client that posts the runner request and opens the returned Playground URL.
43
+
-`figma-to-wordpress-studio/runner-request/v1` for the runner handoff plan.
44
+
- A Figma UI client that posts the runner request and opens the returned Studio URL.
45
45
46
46
Not implemented yet:
47
47
48
-
- The hosted WordPress runner endpoint that creates the Playground session.
48
+
- The hosted WordPress runner endpoint that creates the Studio session.
49
49
- Post-import block validation and visual parity checks.
50
50
51
51
## Local Testing
52
52
53
53
From the repository root, run the plugin checks:
54
54
55
55
```bash
56
-
npm run check --prefix plugins/figma-to-wordpress
57
-
npm run build --prefix plugins/figma-to-wordpress
58
-
npm test --prefix plugins/figma-to-wordpress
56
+
npm run check --prefix plugins/figma-to-wordpress-studio
57
+
npm run build --prefix plugins/figma-to-wordpress-studio
58
+
npm test --prefix plugins/figma-to-wordpress-studio
59
59
```
60
60
61
61
Figma development test:
62
62
63
-
1. Run `npm run build --prefix plugins/figma-to-wordpress`.
64
-
2. Load `plugins/figma-to-wordpress/manifest.json` as a Figma development plugin.
63
+
1. Run `npm run build --prefix plugins/figma-to-wordpress-studio`.
64
+
2. Load `plugins/figma-to-wordpress-studio/manifest.json` as a Figma development plugin.
65
65
3. Run the plugin.
66
-
4. Use `Open in WordPress Playground`.
67
-
5. Confirm the runner service returns a Playground URL that opens in a normal browser tab.
66
+
4. Use `Open in WordPress Studio`.
67
+
5. Confirm the runner service returns a Studio URL that opens in a normal browser tab.
68
68
69
69
## Next Integration Step
70
70
71
-
The next meaningful step is a hosted WordPress runner endpoint with progress/error reporting around the Playground import and post-import block/visual validation. That should remain in the WordPress/Playground runner layer, not by porting PHP importer behavior into the Figma plugin.
71
+
The next meaningful step is a hosted WordPress runner endpoint with progress/error reporting around the Studio import and post-import block/visual validation. That should remain in the WordPress/Studio runner layer, not by porting PHP importer behavior into the Figma plugin.
This plugin moves a Figma file into WordPress by handing the design to a WordPress runner service that imports it with Static Site Importer and Blocks Engine in WordPress Playground.
3
+
This plugin moves a Figma file into WordPress by handing the design to a WordPress runner service that imports it with Static Site Importer and Blocks Engine in WordPress Studio.
4
4
5
-
It does not port Static Site Importer, Blocks Engine, WordPress, PHP, or Playground internals to TypeScript. The TypeScript code extracts Figma scene data, prepares the runner request, and opens the Playground session URL returned by the WordPress-side runner.
5
+
It does not port Static Site Importer, Blocks Engine, WordPress, PHP, or Studio internals to TypeScript. The TypeScript code extracts Figma scene data, prepares the runner request, and opens the Studio session URL returned by the WordPress-side runner.
6
6
7
7
## Flow
8
8
@@ -11,17 +11,17 @@ Figma plugin controller + UI
11
11
-> whole Figma document scene data
12
12
-> runner request
13
13
-> WordPress runner service
14
-
-> WordPress Playground session
14
+
-> WordPress Studio session
15
15
-> Static Site Importer imports through Blocks Engine
16
16
```
17
17
18
18
## Boundaries
19
19
20
20
- Implemented: a Figma Desktop-loadable plugin shell with whole-file export.
21
21
- Implemented: a reusable scene-to-HTML/CSS artifact generator with diagnostics and tests for the current local handoff.
22
-
- Implemented: a product-neutral runner request that can be posted to a WordPress-side Playground session service.
22
+
- Implemented: a product-neutral runner request that can be posted to a WordPress-side Studio session service.
23
23
- Not implemented: running Static Site Importer from TypeScript.
24
-
- Not implemented: the hosted WordPress runner endpoint that creates the Playground session and returns its URL.
24
+
- Not implemented: the hosted WordPress runner endpoint that creates the Studio session and returns its URL.
25
25
- Not implemented: automated visual parity/block validation after import.
26
26
27
27
## Files
@@ -36,21 +36,21 @@ Figma plugin controller + UI
36
36
37
37
## Local Test
38
38
39
-
1. Run `npm run build --prefix plugins/figma-to-wordpress`.
40
-
2. In Figma Desktop, use Plugins -> Development -> Import plugin from manifest, then select `plugins/figma-to-wordpress/manifest.json`.
41
-
3. Open the plugin and choose `Open in WordPress Playground`.
42
-
4. Confirm the WordPress runner service returns a Playground URL and the plugin opens it in a browser tab.
39
+
1. Run `npm run build --prefix plugins/figma-to-wordpress-studio`.
40
+
2. In Figma Desktop, use Plugins -> Development -> Import plugin from manifest, then select `plugins/figma-to-wordpress-studio/manifest.json`.
41
+
3. Open the plugin and choose `Open in WordPress Studio`.
42
+
4. Confirm the WordPress runner service returns a Studio URL and the plugin opens it in a browser tab.
43
43
44
44
For quick syntax verification without a full Figma build pipeline:
45
45
46
46
```bash
47
-
npm run check --prefix plugins/figma-to-wordpress
48
-
npm run build --prefix plugins/figma-to-wordpress
49
-
npm test --prefix plugins/figma-to-wordpress
47
+
npm run check --prefix plugins/figma-to-wordpress-studio
48
+
npm run build --prefix plugins/figma-to-wordpress-studio
49
+
npm test --prefix plugins/figma-to-wordpress-studio
50
50
```
51
51
52
52
## Runner Boundary
53
53
54
-
Figma plugin UIs run in a constrained iframe-like environment. Cross-origin iframes, WASM boot, popup behavior, and navigation can be restricted depending on host context and plugin permissions. The supported boundary is a WordPress-side runner service: the plugin posts a runner request, the service creates the Playground session, and the plugin opens the returned URL.
54
+
Figma plugin UIs run in a constrained iframe-like environment. Cross-origin iframes, WASM boot, popup behavior, and navigation can be restricted depending on host context and plugin permissions. The supported boundary is a WordPress-side runner service: the plugin posts a runner request, the service creates the Studio session, and the plugin opens the returned URL.
55
55
56
-
See [`../../docs/figma-playground-runner.md`](../../docs/figma-playground-runner.md) for the integration notes.
56
+
See [`../../docs/figma-studio-runner.md`](../../docs/figma-studio-runner.md) for the integration notes.
0 commit comments