Repository navigation
Foundation: link the multimodal docs, label Images and Box experimental, correct docs/live.md (Refs #315) - #442
Draft
CompleteDotTech wants to merge 1 commit into
Draft
CompleteDotTech wants to merge 1 commit into
CompleteDotTech wants to merge 1 commit into
Conversation
…d Box experimental, correct docs/live.md (Refs #315) - README.md's docs list links docs/vision.md and docs/multimodal-track.md. - docs/backends.md "Images and Box" opens with the experimental label, quoting the upstream "Dreamer-ready" wording and linking the images and Box pages (read 2026-10-31), and links docs/vision.md. - docs/live.md says an images=True (or long_context=True) backend sends its header on every call it makes, including a text-only call, and documents the SDK 0.7.5 default zstd request compression. - tests/test_docs_links.py fails if the README stops linking either page, if backends.md or fixtures.md stop linking vision.md, if no other docs page links either page, and pins the three docs sentences to the code and the upstream wording. Slice 1 of #315 only. The scaffolder image variant and the docs/recipe-template.md link are deferred to the scaffolder slice. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Co-Authored-By: Claude Haiku 5.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.
Refs #315 (slice 1 of 2: docs reachability and honesty). No closing keyword: the scaffolder slice is not part of this change.
What changed, per item
docs/vision.mdanddocs/multimodal-track.mdREADME.md(hand-written docs list only; "Three pages" became "These pages")docs/backends.mdanddocs/fixtures.mdlinkdocs/vision.mdmain(both pages already linkvision.mdwith anchors);backends.mdalso gets a plain link in its new opening paragraph; pinned by a testdocs/backends.md,tests/test_docs_links.pytests/test_docs_links.pydocs/backends.md"Images and Box" opens with the experimental label and the upstream linkdocs/backends.mddocs/live.mddocuments SDK 0.7.5's default zstd compressiondocs/live.md("What a call does")docs/live.md: animages=Truebackend sends the images header on all of its requests; fix the ambiguous text-only sentence (second review of #297, items 5 and 6)docs/live.md("Experimental images and long context")docs/recipe-template.mdlink,tools/new_recipe.py --images,tests/test_new_recipe.py, agreement testUpstream wording quoted (https://docs.typesafe.ai/images and https://docs.typesafe.ai/primitives/box, both read 2026-10-31; the same banner is on both): "Dreamer-ready. Images and Box questions aren't yet up to our standards to call ready for production, ... The request format, the answers, and the limits on this page can change between releases, and accuracy will change as we update the models." The issue's paraphrase left out "ready for production" and "this page"; the quote in
backends.mduses the real words.Executed on this host, with the outcome
Header behaviour,
LiveBackendwith a recording fake client (the SDK import stubbed for image calls). A text-only call means no image or Box question:imageslong_contextextra_headerspassed tosystem_oneassetsLiveConfigError)src/jev_cookbook/live.pyhas onesystem_one(call site and it spreads the same extras on every attempt.SDK 0.7.5 compression, the wheel's
compression.pyloaded by file path (Python 3.14.3):compression=Noneresolves to zstd when zstd is importable and to no compression when it is not;Falseresolves to none;"zstd"raises when zstd is not importable;"gzip"raises.live.pynever passescompression=, andpyproject.tomlhaslive = ["typesafe-sdk>=0.7.5,<0.8"](no zstd extra).Tests:
tests/test_docs_links.pyagainst an unmodifiedorigin/maintree: 5 failed, 9 passed (README x2, backends label, live headers, live compression fail; the backends/fixtures link tests and the header behaviour test pass because that part is already true).vision.mdlink; label removed; Box link altered; live.md narrows "every call", drops the 1 KiB threshold or the extra clause;live.pysends the images header only with assets, or no long-context header; no docs page linksmultimodal-track.md; the link parser stops skipping fenced code.test_docs_links, test_backends, test_live, test_live_reporting, test_multimodal_backends, test_docs_ruff_versionplus (earlier run)test_live_sdk, test_render_catalog, test_hygiene: 711 passed, 62 skipped (theliveextra is not installed), 5 xfailed, 1 failed:tests/test_live.py::test_importing_and_injecting_works_with_the_sdk_blocked. It fails identically on an unmodifiedorigin/maintree: its subprocess usespython -I, which ignoresPYTHONPATH, andjev_cookbookis not installed in this host's interpreter. Not caused by this change.python tools/check_hygiene.pypassed (635 files);python tools/render_catalog.py --checkexit 0;git diff --checkclean;ruff checkandruff format --checkontests/test_docs_links.pypass with local ruff 0.15.8 (pinned inpyproject.toml: 0.17.2).docs/live.md) in a scratch clone had no conflict and the new tests passed on the merged tree. This branch'slive.mdedits are the images-header paragraph and one bullet in "What a call does"; none touches the lines Foundation: latency capture, run_record capture_date and n, context_size and limits documentation (Refs #312) #394 changes.Read, not executed
extra_headerson the wire, that it compresses only bodies of 1024 bytes or more, and thatContent-Encodingis set: read in the 0.7.5 wheel (transport.py,compression.py) and in the SDK's advanced-usage page.tests/test_live_sdk.pyand thelive_sdktests need the SDK andhttpx2, which are not installed here; they were skipped, not passed.Not yet verified
Deferred, not silently dropped
tools/new_recipe.pyimage variant,tests/test_new_recipe.pyand the agreement-test changes, thedocs/recipe-template.mdlink (the scaffolder slice owns it).docs/notebook-style.mdhas no inbound link fromREADME.md,CONTRIBUTING.mdor anotherdocs/page (onlyrecipes/_template/README.mdlinks it).Prior work
docs/live.md(other sections). Foundation: account for image copies and bytes, preflight the aggregate cap (#313) #372, Foundation: migrate the template and scaffolder onto the audited request-count route (#368) #375 and Foundation C: public dump_responses, honest run-mode sentence, matrix and forced-metric template fixes #317 touched the image and scaffolder areas; nothing here duplicates them.Co-Authored-By: Claude Sonnet 5.5 noreply@anthropic.com
Co-Authored-By: Claude Haiku 5.5 noreply@anthropic.com
Generated with Claude Code