docs: correct v0.6.14 release contracts - #601
Merged
Merged
Conversation
jdchawla29
marked this pull request as ready for review
August 19, 2026 22:30
jdchawla29
force-pushed
the
agent/fix-v0614-docs
branch
from
August 19, 2026 22:30
cd0f77c to
874f796
Compare
jdchawla29
marked this pull request as draft
August 19, 2026 22:31
jdchawla29
marked this pull request as ready for review
August 19, 2026 22:32
jdchawla29
force-pushed
the
agent/fix-v0614-docs
branch
from
August 19, 2026 22:47
874f796 to
b64a6f6
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b64a6f6121
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
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.
Summary
Why
The release documentation stated stronger privacy, isolation, and timing guarantees than the SDK implements and omitted parts of two public surfaces. These changes make the docs describe the shipped code paths and security boundaries directly.
User impact
Users can make informed telemetry and Docker-socket decisions, understand timeout return behavior and runtime resource handling, consume structured Harbor failures, and choose the supported Fireworks cookbook path without release-history or comparison material.
Validation
jq empty docs/docs.jsonuv run --extra dev --extra modal pytest -q hud/tests/test_settings.py hud/telemetry/tests/test_exporter.py hud/telemetry/tests/test_instrument.py hud/eval/tests/test_file_tracking_observer.py hud/eval/tests/test_local_runtime.py hud/eval/tests/test_hosted.py hud/eval/tests/test_rollout.py hud/integrations/harbor/tests/test_contract.py hud/eval/tests/test_docker_provider.py(268 passed)git diff --check origin/main..HEADNote
Low Risk
Documentation-only changes that correct overstated guarantees and disclose telemetry and Docker-socket risks; no runtime or API behavior changes in this PR.
Overview
Aligns v6 documentation with shipped SDK behavior for telemetry, runtimes, verifiers, Harbor, experimental APIs, and the Fireworks cookbook—without changing code.
Telemetry now lists what trace spans can contain (prompts, model output, tool I/O, instrumented call args/results, workspace artifacts) and separates backend uploads, local span files, file-tracking spans, and CLI analytics controls.
Runtime and tasks clarify that
rollout_timeoutcaps execution through grading but not how longTask.run/Taskset.runmay block (post-expiry cancellation, trace reporting, telemetry flush).HUDRuntimeresource handling andLocalRuntimeserialized acquisitions on a shared liveEnvironmentare documented.Experimental pages add stability notices; Harbor documents
AdaptResult/ValueErrorwhen no tasks exist; verifier and Compose docs describe hosted verifier serialization and a Warning that localservice_accessmounts the host Docker daemon.Fireworks material is trimmed to the one-turn importance-sampling serverless path; loss-function comparison, BFCL, and dedicated-vs-serverless sections are removed. The training guide points to that narrower cookbook scope.
Reviewed by Cursor Bugbot for commit b64a6f6. Bugbot is set up for automated code reviews on this repo. Configure here.