@imfusion/web-ui 0.5.1-dev.6.gec5b9f17 → 0.5.1-dev.6.gece7a7b5

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.
Files changed (2) hide show
  1. package/README.md +20 -44
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,11 +2,6 @@
2
2
 
3
3
  `@imfusion/web-ui` — the official shared Web UI library for ImFusion web apps, built on Base UI.
4
4
 
5
- - [Usage](#usage) — install, wire up, and keep the version current
6
- - [Documentation](#documentation) — Storybook and the developer docs
7
- - [Development](#development) — working on the library itself, including the Agent Skills
8
- - [Releasing](#releasing) — how versions are derived and how to cut one
9
-
10
5
  ## Usage
11
6
 
12
7
  The packages are private on npmjs.com.
@@ -38,30 +33,8 @@ import "@imfusion/web-ui/styles.css";
38
33
  import { WebUIProvider } from "@imfusion/web-ui";
39
34
  ```
40
35
 
41
- ### LLM integration
42
-
43
- The `web-ui` package does offer first-class support for LLMs, but it's not wired up by default.
44
-
45
- To install the skills, run this command after the package is installed:
46
-
47
- ```bash
48
- npx web-ui-install-skills
49
- ```
50
-
51
- The binary will ask you which LLM client you want to use and install everything it needs.
52
-
53
- **Available consumer skills - `/imf-web-ui-*`**
54
-
55
- | Skill | What it does |
56
- | ------------------------------------- | ------------------------------------------------------------------------------------ |
57
- | `/imf-web-ui` | The router: decides whether guidance is needed, then which companion to open. |
58
- | `/imf-web-ui-setup` | One-time wiring in a consumer project — the styles import and the provider. |
59
- | `/imf-web-ui-components` | Component reference — what exists and how it's meant to be used. |
60
- | `/imf-web-ui-ux` | UX guidance for building interfaces with the library. |
61
- | `/imf-web-ui-frontend-patterns` | Frontend patterns, including the sanctioned styling seams (tokens, data attributes). |
62
- | `/imf-web-ui-imfusion-frontend-setup` | Set up or audit an ImFusion frontend's tooling against the house baseline. |
63
-
64
- Start at `/imf-web-ui` — it routes to the rest. Storybook's **User Guide → AI Agents** page covers the whole family.
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). **
65
38
 
66
39
  ### Versions and updates
67
40
 
@@ -85,6 +58,20 @@ Every merge to master publishes a new build under the `dev` dist-tag. Which spec
85
58
  - **A `file:` tarball never updates.** npm copies the archive into `node_modules` and re-copies the same one on every
86
59
  install. Switch to `dev` or a version range to get updates.
87
60
 
61
+ ### Consumer skills — `imf-web-ui-*`
62
+
63
+ These skills are shipped with a `imf-web-ui` prefix, so to make their names identifiable and not pollute the skill namespace
64
+ of the user.
65
+
66
+ | Skill | What it does |
67
+ | ------------------------------------- | ------------------------------------------------------------------------------------ |
68
+ | `/imf-web-ui` | The router: decides whether guidance is needed, then which companion to open. |
69
+ | `/imf-web-ui-setup` | One-time wiring in a consumer project — the styles import and the provider. |
70
+ | `/imf-web-ui-components` | Component reference — what exists and how it's meant to be used. |
71
+ | `/imf-web-ui-ux` | UX guidance for building interfaces with the library. |
72
+ | `/imf-web-ui-frontend-patterns` | Frontend patterns, including the sanctioned styling seams (tokens, data attributes). |
73
+ | `/imf-web-ui-imfusion-frontend-setup` | Set up or audit an ImFusion frontend's tooling against the house baseline. |
74
+
88
75
  ## Documentation
89
76
 
90
77
  **[Storybook](https://storybook.js.org/)** is the documentation platform — the component catalog, every prop, and the setup
@@ -107,10 +94,9 @@ npm run git:config # hooks path + rebase-only pull/merge
107
94
 
108
95
  **Try out **`/web-ui-dev-getting-started`** for an ai assisted start.**
109
96
 
110
- ### LLM integration
97
+ ### Development skills — `web-ui-dev-*`
111
98
 
112
- These skills are shipped with a `/web-ui-dev-*` prefix, so to make their names identifiable and not pollute the skill
113
- namespace.
99
+ These skills are shipped with a `web-ui-dev` prefix, so to make their names identifiable and not pollute the skill namespace.
114
100
 
115
101
  | Skill | What it does |
116
102
  | ----------------------------------------- | ------------------------------------------------------------------------------------- |
@@ -145,18 +131,8 @@ Given the tag `web-ui/v0.5.0`:
145
131
  | Exactly on `web-ui/v0.5.0` | `0.5.0` | `latest` |
146
132
  | 5 commits after that tag | `0.5.1-dev.5.gb4de52d7` | `dev` |
147
133
 
148
- The off-tag string breaks down as:
149
-
150
- ```
151
- 0.5.1-dev.5.gb4de52d7
152
- └─┬─┘ └┬┘ │ └───┬────┘
153
- │ │ │ └── commit hash, abbreviated; the leading g means "git"
154
- │ │ └──────── commits since the tag
155
- │ └─────────── pre-release marker, which is what puts it on the dev tag
156
- └──────────────── the tag's version, patch bumped
157
- ```
158
-
159
- Bumping the patch is what makes a dev build sort above the release it follows and below the next one.
134
+ where `5` is the number of commits since the tag and `b4de52d7` the abbreviated hash. Off-tag builds bump the patch, so a dev
135
+ build always sorts above the release it follows and below the next one.
160
136
 
161
137
  Every build of `master` publishes a `dev` version automatically. To check what the current checkout would publish:
162
138
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@imfusion/web-ui",
3
- "version": "0.5.1-dev.6.gec5b9f17",
3
+ "version": "0.5.1-dev.6.gece7a7b5",
4
4
  "description": "The official Web UI component library for ImFusion web apps",
5
5
  "author": "ImFusion GmbH",
6
6
  "license": "UNLICENSED",