docs(roadmap): host killer demo in llm4s, not termflow (§3.3) - #194
Merged
Conversation
Resolves the dependency-direction question raised when sketching §3.3: llm4s already depends on termflow for samples, so hosting an llm4s-backed chat demo here would create a sibling cycle that bites at release time even if the published-artifact graph stays acyclic. §3.3 now describes the app shape (Layout.Border shell, Cmd.asyncResult streaming, Dialogs.confirm tool gating, mouse-wheel scrollback, RequestAttention) and records that the source lives in llm4s with a screenshot + link from termflow's README. §3.6 DoD updated. Recent decisions log gets a one-liner with the rationale.
3 tasks
rorygraves
added a commit
that referenced
this pull request
Apr 30, 2026
Adds docs/contrib/KILLER_DEMO_SPEC.md — a self-contained design doc for the streaming chat-client demo that the llm4s team will implement against a 1.0-RC of termflow. Covers context and ownership, goals and non-goals, UI sketch, full keybinding + slash-command surface, Model and Msg shape, layout (Border + toBudgetedRootNode), streaming token pipeline (Cmd.asyncResult + Sub.Every pump), tool-call flow with Dialogs.confirm gating, termflow API surface checklist with file refs, llm4s API placeholder, acceptance criteria mirroring §3.6, recommended file layout, testing strategy with TuiTestDriver + a stub LlmClient, and a list of open questions for the implementer to resolve in their PR. ROADMAP §3.3 gains a closing paragraph that points at the spec; the existing prose (host-in-llm4s rationale, app shape sketch, slash commands, coordination notes — landed via #194) is unchanged. The spec is registered in docs/SUMMARY.md so it builds with the docs site.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves the dependency-direction question raised when sketching §3.3 in chat: llm4s already depends on termflow for samples, so an llm4s-backed chat demo hosted here would create a sibling cycle that bites at release time even though the published-artifact graph stays acyclic.
§3.3 now:
Cmd.asyncResultstreaming,Dialogs.confirmtool gating, mouse-wheel scrollback via §4.6,Cmd.RequestAttentionfor completed long replies, slash commands).§3.6 DoD updated; §8 recent-decisions log gets a one-liner with the rationale.
No code changes.
Test plan
mdbook build(or local read-through) — no broken links, sentences scan.