Skip to content

Commit dc33be2

Browse files
Jonathan D.A. Jewellclaude
andcommitted
docs: update README, ROADMAP, and SCM files for v0.1.0
Updated user-facing documentation: - README.adoc: v0.1.0-alpha at 95% completion - Updated badges (version, completion, test time) - Updated tech stack (Custom TEA, Deno.test) - Updated development instructions (Deno commands) - Added current status section - ROADMAP.adoc: Marked v0.1.0 tasks complete - Moved completed items to v0.2.0 section - Updated dependencies (removed Vitest, added Deno) - Updated last-updated date (2026-02-07) Updated SCM files: - ECOSYSTEM.scm: Fixed integration-points - Custom TEA (not rescript-tea) - Deno test infrastructure (not Vitest) - @tauri-apps/api (not vitest) - META.scm: Updated ADR-002 decision - Custom TEA for v0.1.0 - rescript-tea migration deferred to v0.2.0 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 73e47dd commit dc33be2

4 files changed

Lines changed: 69 additions & 37 deletions

File tree

.machine_readable/ECOSYSTEM.scm

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@
4242
(integration-points
4343
("Tauri 2.0 - Desktop app framework")
4444
("ReScript - Type-safe frontend compilation")
45-
("rescript-tea - TEA state management library")
46-
("Deno - Runtime for build orchestration")
45+
("Custom TEA - The Elm Architecture state management")
46+
("Deno - Runtime and test infrastructure")
4747
("Tailwind CSS - Styling framework")
48-
("Vitest - Testing framework")))
48+
("@tauri-apps/api - Tauri command bridge")))
4949

5050
(related-projects
5151
((project "hypatia")

.machine_readable/META.scm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
"Need architecture that prevents state corruption and makes reasoning transparent.")
4646
(decision
4747
"Use The Elm Architecture (Model-Update-View with Commands and Subscriptions). "
48-
"Migrating from custom TEA implementation to official rescript-tea@0.16.0. "
48+
"Custom TEA implementation for v0.1.0 (migration to official rescript-tea deferred to v0.2.0). "
4949
"All state changes flow through typed messages, ensuring deterministic updates.")
5050
(consequences
5151
(positive

README.adoc

Lines changed: 43 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@
55
:toc-placement: preamble
66
:icons: font
77

8-
image:https://img.shields.io/github/v/release/hyperpolymath/panll[Release,link="https://github.com/hyperpolymath/panll/releases"]
8+
image:https://img.shields.io/badge/version-v0.1.0--alpha-blue[Version]
9+
image:https://img.shields.io/badge/completion-95%25-brightgreen[Completion]
910
image:https://img.shields.io/badge/License-PMPL--1.0-indigo.svg[PMPL-1.0-or-later,link="LICENSE"]
10-
image:https://img.shields.io/badge/Tests-33%20passing-brightgreen[Tests]
11+
image:https://img.shields.io/badge/Tests-33%20passing%20(719ms)-brightgreen[Tests]
1112
image:https://img.shields.io/badge/Coverage-87--91%25-green[Coverage]
1213
image:https://img.shields.io/badge/RSR-compliant-blue[RSR Compliant]
1314

@@ -41,42 +42,57 @@ This is not a passive text editor. It is an active, synchronous environment that
4142

4243
[cols="1,2"]
4344
|===
44-
|Frontend|ReScript + rescript-tea (TEA pattern)
45+
|Frontend|ReScript + Custom TEA (The Elm Architecture)
4546
|Backend|Rust + Tauri 2.0
46-
|Runtime|Deno
47-
|Styling|Tailwind CSS
47+
|Runtime|Deno (tests, build orchestration)
48+
|Testing|Deno.test (33 tests, 719ms)
49+
|Styling|Tailwind CSS 4.x
4850
|Middleware|Elixir/BEAM (planned)
4951
|Verification|Echidna (planned)
5052
|===
5153

5254
== Development
5355

54-
PanLL relies on Deno tasks to coordinate the Tailwind/Tauri pieces while npm scripts continue to drive ReScript compilation. Run the steps below (or their watchers) inside the repo root:
56+
PanLL uses Deno for runtime, testing, and build orchestration. ReScript compilation uses the symlinked compiler in node_modules.
5557

5658
[source,bash]
5759
----
58-
# Install npm dependencies (ReScript, Tailwind, Tauri CLI)
59-
npm install
60-
6160
# Compile ReScript modules
62-
npm run res:build
61+
node_modules/rescript/rescript build
6362
6463
# Watch ReScript sources during development
65-
npm run res:watch
64+
node_modules/rescript/rescript build -w
6665
67-
# Produce Tailwind CSS via Deno
68-
deno task css:build
66+
# Run tests (33 tests, ~719ms)
67+
deno task test
6968
70-
# Tailwind watch + Tauri dev runner through Deno
69+
# Watch mode for tests
70+
deno task test:watch
71+
72+
# Development mode (Tailwind + Tauri hot reload)
7173
deno task dev
7274
73-
# Tailwind-only watcher (optional)
74-
deno task css:watch
75+
# Build Tailwind CSS
76+
deno task css:build
7577
76-
# Full production build (Tailwind CSS + Tauri)
78+
# Full production build
7779
deno task build
7880
----
7981

82+
=== Quick Start
83+
84+
[source,bash]
85+
----
86+
# 1. Compile ReScript
87+
node_modules/rescript/rescript build
88+
89+
# 2. Run tests to verify
90+
deno task test
91+
92+
# 3. Start development server
93+
deno task dev
94+
----
95+
8096
== Documentation
8197

8298
* **link:docs/TEA_GUIDE.md[TEA Architecture Guide]** — Comprehensive documentation for The Elm Architecture (TEA) implementation including Tea_Cmd, Tea_Sub, Tea_Vdom, and Tea_App modules with testing guide and best practices
@@ -96,4 +112,13 @@ PMPL-1.0-or-later
96112

97113
== Status
98114

99-
v0.0.1-alpha - Initial scaffold
115+
**v0.1.0-alpha** (95% complete)
116+
117+
✅ Complete TEA implementation (Model-Update-View)
118+
✅ All UI components functional (PaneL, PaneN, PaneW, Vexometer, FeedbackOTron)
119+
✅ Tauri 2.0 backend with working commands
120+
✅ 33 tests passing in 719ms (Deno.test)
121+
✅ npm→Deno migration complete
122+
✅ Full ReScript compilation (180ms)
123+
124+
**Next:** v0.1.0 release preparation

ROADMAP.adoc

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,34 @@
77

88
This roadmap outlines the development plan for **PanLL eNSAID** (Environment for NeSy-Agentic Integrated Development), a neurosymbolic agentic development environment built on The Elm Architecture.
99

10-
== Current Status: v0.1.0 (2026-02-04)
10+
== Current Status: v0.1.0 (2026-02-07) - 95% Complete
1111

1212
✅ **Complete TEA Implementation**
1313

14-
* Model-Update-View architecture
14+
* Model-Update-View architecture (custom TEA)
1515
* Command and Subscription management
16-
* Comprehensive test suite (33 tests, 87-91% coverage)
17-
* Modern tooling (Vitest, Deno, Tauri 2.0)
18-
* Complete documentation
16+
* Comprehensive test suite (33 tests, 87-91% coverage, 719ms execution)
17+
* Modern tooling (Deno.test, Tauri 2.0, ReScript 11.1)
18+
* npm→Deno migration complete
19+
* All UI components functional (PaneL, PaneN, PaneW, Vexometer, FeedbackOTron)
20+
* Tauri backend commands working (validate_inference, get_vexation_index, submit_feedback)
1921

2022
== Roadmap
2123

22-
=== v0.2.0 - Enhanced UI & Components (Q1 2026)
24+
=== v0.2.0 - Enhanced Features & Polish (Q1 2026)
25+
26+
==== Completed in v0.1.0
27+
* [x] Complete Tauri desktop app integration
28+
* [x] Functional UI components
29+
- [x] FeedbackOTron component
30+
- [x] Vexometer component
31+
- [x] PaneL/PaneN/PaneW components
2332

2433
==== Must Have
25-
* [ ] Complete Tauri desktop app integration
26-
* [ ] Functional UI components (current stubs)
27-
- [ ] FeedbackOTron component
28-
- [ ] Vexometer component
29-
- [ ] PaneL/PaneN/PaneW components
30-
* [ ] State persistence
34+
* [ ] Migration to official rescript-tea (deferred from v0.1.0)
35+
* [ ] State persistence (localStorage/Tauri)
3136
* [ ] Basic settings management
37+
* [ ] Polish UI/UX based on user feedback
3238

3339
==== Should Have
3440
* [ ] Keyboard shortcuts fully implemented
@@ -186,8 +192,9 @@ This roadmap outlines the development plan for **PanLL eNSAID** (Environment for
186192
=== Current Dependencies
187193
* ReScript 11.1.x
188194
* Tauri 2.x
189-
* Vitest 4.x
190-
* Deno runtime
195+
* Deno runtime (tests + build)
196+
* Tailwind CSS 4.x
197+
* @tauri-apps/api 2.x
191198

192199
=== Planned Integrations
193200
* VSCode extension
@@ -238,6 +245,6 @@ This roadmap outlines the development plan for **PanLL eNSAID** (Environment for
238245

239246
---
240247

241-
_Last Updated: 2026-02-04_
248+
_Last Updated: 2026-02-07_
242249

243250
_This roadmap is a living document and will be updated as the project evolves._

0 commit comments

Comments
 (0)