Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .beads/issues.jsonl
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
{"id":"ge-hch.1.7.1","title":"Implement: notes","description":"Implement: notes - code, prefabs, editor scripts as required.\\n\\n## Acceptance Criteria\\n- Implementation produces the minimal functionality described in the feature acceptance criteria.\\n\\n## Minimal Implementation\\n- Deliver the smallest end-to-end code required.","notes":"Covered by Playwright smoke tests: tests/demo.smoke.spec.ts loads demo and advances via click/keyboard/tap/controller; telemetry test asserts story flow; workflow .github/workflows/playwright.yml runs in CI.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-03T20:44:43.511678759-08:00","created_by":"rgardler","updated_at":"2026-01-07T01:44:42.876401091-08:00","closed_at":"2026-01-07T01:44:42.876411101-08:00","dependencies":[{"issue_id":"ge-hch.1.7.1","depends_on_id":"ge-hch.1.7","type":"parent-child","created_at":"2026-01-03T20:44:43.512516762-08:00","created_by":"rgardler"}]}
{"id":"ge-hch.1.7.2","title":"Tests: notes","description":"Tests: notes - create automated tests (browser unit / integration / E2E) required by feature.\\n\\n## Acceptance Criteria\\n- Tests exist and pass locally and in CI.\\n\\n## Minimal Implementation\\n- Add at least one browser E2E test covering feature behavior.","notes":"Tests in place: tests/demo.smoke.spec.ts (load + input variants) and tests/demo.telemetry.spec.ts (story_start, choice_selected, smoke_triggered, story_complete + smoke state). CI via .github/workflows/playwright.yml.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-03T20:44:43.560788657-08:00","created_by":"rgardler","updated_at":"2026-01-07T01:44:46.310502311-08:00","closed_at":"2026-01-07T01:44:46.310508691-08:00","dependencies":[{"issue_id":"ge-hch.1.7.2","depends_on_id":"ge-hch.1.7","type":"parent-child","created_at":"2026-01-03T20:44:43.562217108-08:00","created_by":"rgardler"}]}
{"id":"ge-hch.1.7.3","title":"Docs: notes","description":"Docs: notes - write short runbook/docs.\\n\\n## Acceptance Criteria\\n- Docs explain how to run, test, and validate the feature.\\n\\n## Minimal Implementation\\n- Add section to docs or feature README.","notes":"Doc/testing coverage referenced via Playwright suites: tests/demo.smoke.spec.ts and tests/demo.telemetry.spec.ts; CI runs them in .github/workflows/playwright.yml.","status":"closed","priority":2,"issue_type":"task","created_at":"2026-01-03T20:44:43.630382338-08:00","created_by":"rgardler","updated_at":"2026-01-07T01:44:58.075296247-08:00","closed_at":"2026-01-07T01:44:58.075302957-08:00","dependencies":[{"issue_id":"ge-hch.1.7.3","depends_on_id":"ge-hch.1.7","type":"parent-child","created_at":"2026-01-03T20:44:43.631471796-08:00","created_by":"rgardler"}]}
{"id":"ge-hch.1.8","title":"Risk notes","description":"Risk notes: Short risk \u0026 mitigation doc capturing WebGL constraints, telemetry gaps, Ink integration questions, and editor/versioning issues.\\n\\n## Acceptance Criteria\\n- docs/risk_notes.md lists top 3 risks and mitigations.\\n\\n## Minimal Implementation\\n- Create docs/risk_notes.md with initial entries.","status":"open","priority":2,"issue_type":"feature","created_at":"2026-01-03T20:19:38.20942699-08:00","created_by":"rgardler","updated_at":"2026-01-03T20:19:38.20942699-08:00","dependencies":[{"issue_id":"ge-hch.1.8","depends_on_id":"ge-hch.1","type":"parent-child","created_at":"2026-01-03T20:19:38.21058871-08:00","created_by":"rgardler"}]}
{"id":"ge-hch.1.8","title":"Risk notes","description":"Risk notes: Short risk \u0026 mitigation doc capturing WebGL constraints, telemetry gaps, Ink integration questions, and editor/versioning issues.\\n\\n## Acceptance Criteria\\n- docs/risk_notes.md lists top 3 risks and mitigations.\\n\\n## Minimal Implementation\\n- Create docs/risk_notes.md with initial entries.","notes":"PR opened: https://github.com/TheWizardsCode/GEngine/pull/100","status":"in_progress","priority":2,"issue_type":"feature","created_at":"2026-01-03T20:19:38.20942699-08:00","created_by":"rgardler","updated_at":"2026-01-07T01:57:57.458642517-08:00","external_ref":"https://github.com/TheWizardsCode/GEngine/pull/100","labels":["Status: PR Created"],"dependencies":[{"issue_id":"ge-hch.1.8","depends_on_id":"ge-hch.1","type":"parent-child","created_at":"2026-01-03T20:19:38.21058871-08:00","created_by":"rgardler"}]}
{"id":"ge-hch.1.8.1","title":"Implement: Risk","description":"Implement: Risk - code, prefabs, editor scripts as required.\\n\\n## Acceptance Criteria\\n- Implementation produces the minimal functionality described in the feature acceptance criteria.\\n\\n## Minimal Implementation\\n- Deliver the smallest end-to-end code required.","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-03T20:44:45.80003094-08:00","created_by":"rgardler","updated_at":"2026-01-03T20:44:45.80003094-08:00","dependencies":[{"issue_id":"ge-hch.1.8.1","depends_on_id":"ge-hch.1.8","type":"parent-child","created_at":"2026-01-03T20:44:45.801328409-08:00","created_by":"rgardler"}]}
{"id":"ge-hch.1.8.2","title":"Tests: Risk","description":"Tests: Risk - create automated tests (browser unit / integration / E2E) required by feature.\\n\\n## Acceptance Criteria\\n- Tests exist and pass locally and in CI.\\n\\n## Minimal Implementation\\n- Add at least one browser E2E test covering feature behavior.","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-03T20:44:45.853194129-08:00","created_by":"rgardler","updated_at":"2026-01-06T22:00:25.333147223-08:00","dependencies":[{"issue_id":"ge-hch.1.8.2","depends_on_id":"ge-hch.1.8","type":"parent-child","created_at":"2026-01-03T20:44:45.854214358-08:00","created_by":"rgardler"}]}
{"id":"ge-hch.1.8.3","title":"Docs: Risk","description":"Docs: Risk - write short runbook/docs.\\n\\n## Acceptance Criteria\\n- Docs explain how to run, test, and validate the feature.\\n\\n## Minimal Implementation\\n- Add section to docs or feature README.","status":"open","priority":2,"issue_type":"task","created_at":"2026-01-03T20:44:45.904222604-08:00","created_by":"rgardler","updated_at":"2026-01-03T20:44:45.904222604-08:00","dependencies":[{"issue_id":"ge-hch.1.8.3","depends_on_id":"ge-hch.1.8","type":"parent-child","created_at":"2026-01-03T20:44:45.905057899-08:00","created_by":"rgardler"}]}
Expand Down
16 changes: 16 additions & 0 deletions docs/risk_notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Risk notes (M0 InkJS demo)

## 1) Story/runtime version skew
- **Risk**: Ink stories compiled with a different ink/inkjs version may fail at runtime or diverge in branching/telemetry behaviour.
- **Impact**: Story load/runtime errors; subtle logic differences; broken telemetry assertions.
- **Mitigation**: Pin inkjs/ink compiler versions; keep compiled artifacts in-sync with source; add a simple compatibility check in build/test (fail fast if compile/runtime versions diverge); run Playwright smoke + telemetry tests after story updates.

## 2) Telemetry and smoke observability gaps
- **Risk**: Telemetry events (story_start, choice_selected, smoke_triggered, story_complete) or smoke_state events may not fire under certain paths or regress.
- **Impact**: Missing analytics/observability; CI flakes when telemetry assertions fail.
- **Mitigation**: Keep the telemetry facade default-enabled in demo; retain Playwright telemetry test coverage (tests/demo.telemetry.spec.ts) and smoke inputs (tests/demo.smoke.spec.ts); capture console logs in CI artifacts; add regression checks when new inputs/story branches are added.

## 3) Browser/platform performance constraints (smoke visual)
- **Risk**: Smoke effect or story load stutters/fails on low-end or mobile browsers (WebGL/canvas/JS perf, network latency for story assets).
- **Impact**: Poor UX or timeouts in CI (touch profile) and on devices; potential skips of smoke trigger.
- **Mitigation**: Keep smoke effect lightweight (CSS/Canvas) and configurable; test on touch profile in Playwright; keep demo assets small and served over HTTP (avoid file://); document fallback to disable smoke or reduce intensity/duration for constrained environments.