@imfusion/web-ui 0.5.1-dev.2.g0a349a2a → 0.5.1-dev.2.gf11bbed1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -33,8 +33,8 @@ import "@imfusion/web-ui/styles.css";
|
|
|
33
33
|
import { WebUIProvider } from "@imfusion/web-ui";
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
|
|
36
|
+
**There is also an AI skill to help you set up the Web UI library in your project:
|
|
37
|
+
[`/imf-web-ui-setup`](./src/llms/skills/imf-web-ui-setup/SKILL.md). **
|
|
38
38
|
|
|
39
39
|
## Development
|
|
40
40
|
|
|
@@ -45,11 +45,7 @@ npm install
|
|
|
45
45
|
npm run git:config # hooks path + rebase-only pull/merge
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
> [!IMPORTANT] `npm run git:config` is a separate, explicit step. `.npmrc` sets `ignore-scripts=true` to blunt supply-chain
|
|
51
|
-
> attacks, and that disables this package's own lifecycle scripts too — so nothing configures git for you. It sets
|
|
52
|
-
> `.githooks` as the hooks path and pins `pull.rebase true` / `merge.ff only`.
|
|
48
|
+
**Try out **`/web-ui-dev-getting-started`** for an ai assisted start.**
|
|
53
49
|
|
|
54
50
|
## Documentation
|
|
55
51
|
|
|
@@ -71,33 +67,11 @@ Two families of Agent Skills, told apart by their prefix:
|
|
|
71
67
|
| `imf-web-ui-*` | Apps consuming the library | shipped in the npm package | `npx web-ui-install-skills` |
|
|
72
68
|
| `web-ui-dev-*` | Developing the library itself | `.agents/skills/` | already there after cloning |
|
|
73
69
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
**`imf-web-ui-*`** travels with the package, so an agent in a consumer app gets library guidance without reading this
|
|
77
|
-
library's source. ` imf-web-ui` — the bare name, no suffix — is the router: it costs little to load and decides which
|
|
78
|
-
companion applies, or that none does.
|
|
79
|
-
|
|
80
|
-
The companions cover library wiring (`-setup`), the component reference (`-components`), UX guidance (`-ux`), frontend
|
|
81
|
-
patterns (`-frontend-patterns`), and ImFusion project tooling (`-imfusion-frontend-setup`).
|
|
70
|
+
### Development skills — `web-ui-dev-*`
|
|
82
71
|
|
|
83
72
|
**`web-ui-dev-*`** never ships; it's the workflow for working on this repo — scaffolding a component, authoring a story,
|
|
84
73
|
committing. Start with `/web-ui-dev-getting-started`, which routes you the same way.
|
|
85
74
|
|
|
86
|
-
The split is the audience, and the prefix is how you tell at a glance which side of the package boundary a skill sits on.
|
|
87
|
-
|
|
88
|
-
### Consumer skills — `imf-web-ui-*`
|
|
89
|
-
|
|
90
|
-
| Skill | What it does |
|
|
91
|
-
| ------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
92
|
-
| `/imf-web-ui` | The router: decides whether guidance is needed, then which companion to open. |
|
|
93
|
-
| `/imf-web-ui-setup` | One-time wiring in a consumer project — the styles import and the provider. |
|
|
94
|
-
| `/imf-web-ui-components` | Component reference — what exists and how it's meant to be used. |
|
|
95
|
-
| `/imf-web-ui-ux` | UX guidance for building interfaces with the library. |
|
|
96
|
-
| `/imf-web-ui-frontend-patterns` | Frontend patterns, including the sanctioned styling seams (tokens, data attributes). |
|
|
97
|
-
| `/imf-web-ui-imfusion-frontend-setup` | Set up or audit an ImFusion frontend's tooling against the house baseline. |
|
|
98
|
-
|
|
99
|
-
### Development skills — `web-ui-dev-*`
|
|
100
|
-
|
|
101
75
|
| Skill | What it does |
|
|
102
76
|
| ----------------------------------------- | ------------------------------------------------------------------------------------- |
|
|
103
77
|
| `/web-ui-dev-getting-started` | Interactive intro — gauges your experience, works out your goal, routes you. |
|
|
@@ -113,4 +87,22 @@ The split is the audience, and the prefix is how you tell at a glance which side
|
|
|
113
87
|
| `/web-ui-dev-refresh-design-reference` | Refresh the committed brand snapshots in `design/` from the Figma styleguide. |
|
|
114
88
|
| `/web-ui-dev-mcp` | Set up or recover Storybook, DevTools, Atlassian, or Figma MCP access. |
|
|
115
89
|
|
|
90
|
+
### Consumer skills — `imf-web-ui-*`
|
|
91
|
+
|
|
92
|
+
**`imf-web-ui-*`** travels with the package, so an agent in a consumer app gets library guidance without reading this
|
|
93
|
+
library's source. ` imf-web-ui` — the bare name, no suffix — is the router: it costs little to load and decides which
|
|
94
|
+
companion applies, or that none does.
|
|
95
|
+
|
|
96
|
+
The companions cover library wiring (`-setup`), the component reference (`-components`), UX guidance (`-ux`), frontend
|
|
97
|
+
patterns (`-frontend-patterns`), and ImFusion project tooling (`-imfusion-frontend-setup`).
|
|
98
|
+
|
|
99
|
+
| Skill | What it does |
|
|
100
|
+
| ------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
101
|
+
| `/imf-web-ui` | The router: decides whether guidance is needed, then which companion to open. |
|
|
102
|
+
| `/imf-web-ui-setup` | One-time wiring in a consumer project — the styles import and the provider. |
|
|
103
|
+
| `/imf-web-ui-components` | Component reference — what exists and how it's meant to be used. |
|
|
104
|
+
| `/imf-web-ui-ux` | UX guidance for building interfaces with the library. |
|
|
105
|
+
| `/imf-web-ui-frontend-patterns` | Frontend patterns, including the sanctioned styling seams (tokens, data attributes). |
|
|
106
|
+
| `/imf-web-ui-imfusion-frontend-setup` | Set up or audit an ImFusion frontend's tooling against the house baseline. |
|
|
107
|
+
|
|
116
108
|
Keep these tables current when a skill is added, renamed, or removed — `/web-ui-dev-audit-docs` checks them.
|
package/package.json
CHANGED