tools.html: say where the harness and tee relay actually come from - #106
Merged
Conversation
The toolkit page lists six tools under "What's in the box", each with a command and no indication of where it comes from. Two of them do not come from the engine wheel, and the page's framing implies they do. - **Test harness** (`python -m harness`) ships as its own distribution, `messagefoundry-harness`, released in lockstep with the engine. The engine wheel is `only-include = ["messagefoundry", ...]`, so `harness/` is not in it; the harness distribution force-includes it. The card now says so. This is the item deferred in #99, where the fix might have been engine packaging rather than site copy — it wasn't; the packaging is deliberate. - **Tee relay** (`python -m tee`) is worse and was not previously flagged: `tee/` is a repo-root directory, is not inside `messagefoundry/`, is not force-included by ANY distribution, and has no entry point. There is no `packaging/messagefoundry-tee`. So it is reachable only from a source checkout — no published package provides it. The card now says that too. Neither command was wrong; both worked once you had the right thing installed. The defect was that the page never told you what that was, while presenting them alongside tools that do ship with `pip install messagefoundry`. Verified against the engine: `pyproject.toml:21` (wheel contents), `packaging/` (only messagefoundry-harness and messagefoundry-webconsole), `[project.scripts]` / `[project.gui-scripts]` (no tee entry point). The doc sources already state the harness packaging correctly after #100/#101, so this brings the HTML into line with the PDFs rather than inventing a new claim. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
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.
Closes the one item deliberately deferred in #99 — and turns up a second, worse instance beside it.
The problem
tools.htmllists six tools under "What's in the box", each with a command and no indication ofwhere it comes from. Two of them don't come from the engine wheel, and the page's framing implies
they do.
python -m harnessmessagefoundry-harness— the engine wheel isonly-include = ["messagefoundry", …], soharness/isn't in itpython -m teeNeither command is wrong; both work once you have the right thing installed. The defect is that the
page never told you what that was, while listing them alongside tools that do come with
pip install messagefoundry.The tee relay is the sharper find
It wasn't in the audit and I hadn't flagged it.
tee/is a repo-root directory, not insidemessagefoundry/, not force-included by any distribution (onlymessagefoundry-harnessdoes that,for
harness/), and has no entry point. There is nopackaging/messagefoundry-tee. So unlike theharness — which at least has a distribution — the tee relay is reachable only from a source checkout.
Verified against the engine, not assumed
pyproject.toml:21—only-include = ["messagefoundry", "README.md", "CHANGELOG.md", "LICENSE", "NOTICE"]packaging/— contains exactlymessagefoundry-harnessandmessagefoundry-webconsolepackaging/messagefoundry-harness/pyproject.toml:54—force-include = { "../../harness" = "harness" }[project.scripts]/[project.gui-scripts]—messagefoundryandmessagefoundry-trayonly; no teeThe doc sources already state the harness packaging correctly after #100/#101 (
Install-Guide.md:270,System-Requirements.md:130), so this brings the HTML into line with the published PDFs rather thaninventing a new claim.
tools.htmlwas the last place on the site that disagreed.Scope
Two sentences, one file, no structural or CSS change — text appended inside two existing
<p>elements.🤖 Generated with Claude Code