docs: add a capabilities column and say what is not covered - #63
Open
rickstaa wants to merge 1 commit into
Open
Conversation
rickstaa
force-pushed
the
rs/ollama-multi-model
branch
from
August 10, 2026 10:50
9e35568 to
5bd3d85
Compare
The table tracked four axes, and ollama fits all four while doing something none of the others do: registering several apps from one process. That is a dimension, not a value, so it gets a column rather than an exception, and the curation rule stays true as written. Drops the promise of "a full example that exercises every feature". With the axes covered, such an example would only repeat the others. Adds a short list of runner features no example shows -- proxy mode, label and version, changing status while running -- so their absence reads as a choice. Links the two known gaps, capacity accounting and sessions that are never released offchain, since both bite in deployment rather than in the demo. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
rickstaa
force-pushed
the
rs/readme-coverage
branch
from
August 10, 2026 10:51
899dfcc to
6eefbd1
Compare
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.
Three README changes that make the table honest again after
ollama.A
Capabilitiescolumnollamafits all four existing axes — dynamic, single-shot, HTTP + SSE, hour — while doing something no other example does: registering several apps from one process. That is a dimension, not a value, so the table gains a column reading1everywhere andNforollama, rather than the curation rule quietly acquiring an exception. The rule at the bottom of the section now lists five axes and stays true as written.Drops a promise that no longer makes sense
With every axis covered, an example that exercised every feature would just be the other seven glued together. Removed rather than left as an aspiration nobody intends to fulfil.
A "Not covered here" section
Right now a reader cannot distinguish "the runner can't do this" from "we chose not to show it". Three features, with the reason each is absent:
proxy: true) — the orchestrator hands out an opaque per-session URL from a configurable template instead of the default/apps/{runner}/session/{session}/app, and the placeholder may sit in the host, giving each session its own origin. That matters for browser apps, where cookies, CORS, and service workers are per-origin, and for anything serving assets from absolute paths. No example because the app-side change is one boolean; everything interesting is orchestrator configuration.labelandversion— carried to discovery, no behavioural effect, yours for bookkeeping.statuswhile running — a runner can heartbeat itself out ofreadyto stop receiving sessions. Useful when one process registers several apps sharing hardware, but the SDK has no public setter yet.It also links the two gaps worth knowing before deploying: capacity tracked per registration rather than per machine (go-livepeer#4015), and persistent sessions never released offchain when a client disappears (go-livepeer#4016). Both bite in deployment rather than in the demo, which is exactly why the README should name them.
Stacked on #62 since it needs the
ollamarow to exist.🤖 Generated with Claude Code