tmk241/hemx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(requirements): split example rows

Browse Source 
Add explicit northstar ring fields to example requirements and split shared-runtime and mobile-framework boundaries without changing behavior.

req: examples/001

req: examples/002

req: examples/003

req: examples/004

req: examples/005

req: examples/006

req: examples/007

req: examples/008

req: examples/009

req: examples/010

req: examples/011

req: examples/012

req: examples/013
This commit is contained in:
slhx agent
2026-06-25 17:29:24 +02:00
parent 1a9387dca9
commit ceb06a7723
2 changed files with 19 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
REQUIREMENTS.md
+17 -11
View File
@@ -969,37 +969,43 @@ what a valid business email is. [north_star]
## examples
### req: examples/001
001 The repository must contain canonical examples that act as API tests. The v0 set covers counter, todo CRUD, form wizard, docs-site page swap, auth action, SSE notifications, and keyed todo list. [north_star]
0 001 The repository must contain canonical examples that act as API tests. The v0 set covers counter, todo CRUD, form wizard, docs-site page swap, auth action, SSE notifications, and keyed todo list. [north_star]
### req: examples/007
007 `examples/html_examples` is the copy-paste HTML pattern gallery proving htmx-style CRUD/form/search/load patterns map to boring `.heml`, generated resources, and server-owned Rust state. [north_star]
0 007 `examples/html_examples` is the copy-paste HTML pattern gallery proving htmx-style CRUD/form/search/load patterns map to boring `.heml`, generated resources, and server-owned Rust state. [north_star]
### req: examples/008
008 The Workout example is the phone-first local-first product exemplar for commands/events/projections, complete session flow, recovery, host/replay failures, and host boundary results returned through app code. [north_star]
0 008 The Workout example is the phone-first local-first product exemplar for commands/events/projections, complete session flow, recovery, host/replay failures, and host boundary results returned through app code. [north_star]
### req: examples/009
009 Local-first kanban is a north-star milestone example. The full techdemo may include an opaque leaf-widget island that communicates through `Effect::event`, without moving island mechanics into hemx core. [north_star]
0 009 Local-first kanban is a north-star milestone example. The full techdemo may include an opaque leaf-widget island that communicates through `Effect::event`, without moving island mechanics into hemx core. [north_star]
### req: examples/002
002 Each example must have a maximum ceremony budget. The counter example must fit in under 50 lines of user-authored Rust plus one template. Todo CRUD must fit in under 150 lines excluding model definitions.
0 002 Each example must have a maximum ceremony budget. The counter example must fit in under 50 lines of user-authored Rust plus one template. Todo CRUD must fit in under 150 lines excluding model definitions. [north_star]
### req: examples/003
003 If an example requires raw EffectWriter, manual ids, manual JS, or manual registry setup, the API is considered too complex.
0 003 If an example requires raw EffectWriter, manual ids, manual JS, or manual registry setup, the API is considered too complex. [north_star]
### req: examples/004
004 Canonical examples are compile-tested golden API contracts. Changing generated API shape requires updating the examples deliberately.
0 004 Canonical examples are compile-tested golden API contracts. Changing generated API shape requires updating the examples deliberately. [north_star]
### req: examples/005
005 Canonical examples must not contain user-authored browser JavaScript. They may load the shared hemx runtime (`/hemx.js`) and may use declarative `data-hemx-*` attributes; inline `<script>`, `on*=` event handlers, and `javascript:` URLs are forbidden outside opaque leaf-widget examples.
0 005 Canonical examples must not contain user-authored browser JavaScript; inline `<script>`, `on*=` handlers, and `javascript:` URLs are forbidden outside opaque leaf-widget examples. [north_star]
### req: examples/012
0 012 Canonical examples may load the shared hemx runtime (`/hemx.js`) and may use declarative `data-hemx-*` attributes. [north_star]
### req: examples/006
006 The Workout exemplar must have one boring command surface for local development, product tests, production server build, Android/iOS mobile release metadata, and mobile verification. [north_star]
0 006 The Workout exemplar must have one boring command surface for local development, product tests, production server build, Android/iOS mobile release metadata, and mobile verification. [north_star]
### req: examples/010
010 The Workout common path uses generated helpers instead of manual registry conversion. [north_star]
0 010 The Workout common path uses generated helpers instead of manual registry conversion. [north_star]
### req: examples/011
011 Workout mobile commands make app identity, version, production origin, runtime asset policy, cache/offline policy, environment/secrets boundary, rollback expectation, and external store-signing/submission blockers explicit without adding a broad `hemx-mobile` framework. [north_star]
0 011 Workout mobile commands make app identity, version, production origin, runtime asset policy, cache/offline policy, environment/secrets boundary, rollback expectation, and external store-signing/submission blockers explicit. [north_star]
### req: examples/013
0 013 Workout mobile commands must not add a broad `hemx-mobile` framework. [north_star]
---