Skip to content

docs: §3.3 killer-demo screenshot + llm4s link in README#201

Merged
rorygraves merged 2 commits into
mainfrom
docs/readme-killer-demo
May 1, 2026
Merged

docs: §3.3 killer-demo screenshot + llm4s link in README#201
rorygraves merged 2 commits into
mainfrom
docs/readme-killer-demo

Conversation

@rorygraves
Copy link
Copy Markdown
Contributor

Summary

The llm4s streaming chat client shipped — TermFlow's killer demo is now real and on a stable upstream. This PR wires it into the termflow README per the §3.6 DoD:

  • New screenshot at docs/assets/chat-ui-screenshot.png, embedded after the elevator pitch.
  • Caption frames what the demo shows: streaming, auto-tail, mouse-wheel scrollback, light/dark theme, slash commands, pinned bottom prompt.
  • "Built with TermFlow — source at llm4s/llm4s/.../chat/tui" link to the llm4s repo.

Roadmap §3.3 marked ☑ landed; §3.6 DoD's "README headline screenshot" box ticked. With PR #200 (§4.5) also in flight, only §4.2 (release-doc sweep) remains in §4 before 1.0-RC.

Test plan

  • mdbook build clean
  • Screenshot renders correctly inline in the README (relative path resolves on GitHub)
  • Link to llm4s chat client resolves (verified: 200)
  • No code changes

rorygraves added 2 commits May 1, 2026 09:22
The llm4s streaming chat client shipped at
modules/samples/.../chat/tui in the llm4s repo. README now leads with
the chat-client screenshot (docs/assets/chat-ui-screenshot.png) plus
a "Built with TermFlow — source at llm4s/llm4s/.../chat/tui" link,
exactly as the §3.6 DoD asks.

Roadmap §3.3 marked landed; §3.6 DoD line ticked. With this and the
in-flight §4.5 PR, only §4.2 (release-doc sweep) remains for 1.0.
@rorygraves rorygraves merged commit d576bb0 into main May 1, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant