openuispec 0.1.7 → 0.1.8

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/cli/init.ts +23 -3
  2. package/package.json +2 -1
package/cli/init.ts CHANGED
@@ -170,6 +170,17 @@ OpenUISpec is a YAML-based format that describes your app's UI semantically —
170
170
  - \`draft\` — actively being specced. Tracked by drift.
171
171
  - \`ready\` — fully specified (default if omitted). Tracked by drift.
172
172
 
173
+ ## Learning OpenUISpec — local files and online reference
174
+
175
+ All documentation is included in the installed package at \`node_modules/openuispec/\`:
176
+ 1. **Full specification:** \`node_modules/openuispec/spec/openuispec-v0.1.md\`
177
+ 2. **Example app:** \`node_modules/openuispec/examples/taskflow/\`
178
+ 3. **JSON Schemas:** \`node_modules/openuispec/schema/\`
179
+
180
+ If the package is not in node_modules, fetch the full reference from:
181
+ - \`https://openuispec.rsteam.uz/llms-full.txt\` — complete spec + all JSON schemas in one file
182
+ - \`https://openuispec.rsteam.uz/llms.txt\` — concise summary with links
183
+
173
184
  ## JSON Schemas (validation & file structure)
174
185
 
175
186
  **IMPORTANT:** Before creating or editing any spec file, read the corresponding JSON Schema to understand the valid structure. Schemas are located in the installed package:
@@ -288,8 +299,18 @@ This means the project has existing UI code but hasn't been specced yet. Your jo
288
299
  2. Run \`openuispec drift --snapshot --target <target>\` for each affected platform.
289
300
  3. Run \`openuispec drift\` to verify no untracked drift remains.
290
301
 
302
+ ## Learning OpenUISpec — local files and online reference
303
+ All documentation is included in the installed package at \`node_modules/openuispec/\`:
304
+ 1. **Full specification:** \`node_modules/openuispec/spec/openuispec-v0.1.md\` — the complete spec (read this to understand the format)
305
+ 2. **Example app:** \`node_modules/openuispec/examples/taskflow/\` — a complete working app with all file types
306
+ 3. **JSON Schemas:** \`node_modules/openuispec/schema/\` — validation schemas that define the exact structure of every file type
307
+
308
+ If the package is not in node_modules, fetch the full reference from:
309
+ - \`https://openuispec.rsteam.uz/llms-full.txt\` — complete spec + all JSON schemas in one file
310
+ - \`https://openuispec.rsteam.uz/llms.txt\` — concise summary with links
311
+
291
312
  ## JSON Schemas — read before creating spec files
292
- Before creating or editing any spec file, read the corresponding JSON Schema to understand the valid structure. Schemas are in the installed package:
313
+ Before creating or editing any spec file, read the corresponding JSON Schema to understand the valid structure:
293
314
  - \`node_modules/openuispec/schema/openuispec.schema.json\` — root manifest
294
315
  - \`node_modules/openuispec/schema/screen.schema.json\` — screens
295
316
  - \`node_modules/openuispec/schema/flow.schema.json\` — flows
@@ -299,8 +320,7 @@ Before creating or editing any spec file, read the corresponding JSON Schema to
299
320
  - \`node_modules/openuispec/schema/tokens/*.schema.json\` — token files (color, typography, spacing, elevation, motion, layout, themes, icons)
300
321
  - \`node_modules/openuispec/schema/defs/*.schema.json\` — shared types (actions, data-binding, adaptive, validation, common)
301
322
 
302
- Workflow: read the schema → create the YAML → run \`openuispec validate\`.
303
- Example spec files: \`node_modules/openuispec/examples/taskflow/\` — a complete app with all file types.
323
+ Workflow: read the spec → read the schema → read an example → create the YAML → run \`openuispec validate\`.
304
324
 
305
325
  ## Spec format reference
306
326
  - 7 contract families: nav_container, surface, action_trigger, input_field, data_display, collection, feedback
package/package.json CHANGED
@@ -1,9 +1,10 @@
1
1
  {
2
2
  "name": "openuispec",
3
- "version": "0.1.7",
3
+ "version": "0.1.8",
4
4
  "license": "MIT",
5
5
  "type": "module",
6
6
  "description": "A semantic UI specification format for AI-native, platform-native app development",
7
+ "homepage": "https://openuispec.rsteam.uz",
7
8
  "repository": {
8
9
  "type": "git",
9
10
  "url": "https://github.com/rsktash/openuispec.git"