Repository navigation
docs: rewrite README against the code, add Docker Hub overview and banner - #3
Merged
Merged
Conversation
…nner README: - Trace direction corrected: each call starts a Parallax trace and the callee's spans join it (only if the callee reads W3C trace context). - Scope stated exactly: HTTP GET/HEAD plus the gRPC health check, OTLP over gRPC only. "Repeat-safe by default" becomes "repeat-safe only". - Install section for v0.1.0: release binaries with checksum steps, the immersivefusion/parallax image, and building from source. - Missing flags added (-results, -version, -manifest -); -headers default corrected; real dry-run and -once -results jsonl output. - Behavior an operator needs: what "unanswered" means, rate budget is an average checked at plan build, rule paths match the route path only, credentials in a baseURL are sent and printed, health endpoints report Parallax's own health, sampling, the 1 MiB body read, and that -once can currently exit 0 when interrupted mid-pass. DOCKERHUB.md: canonical source for the Hub overview, derived from the README, with a dry-run sample captured from the 0.1.0 image. Supersedes the version in #2. Both passed the C2 documentation quality gate (README 0.921, Hub page 0.923, no Critical or Major findings). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Release links use /releases/latest and the untagged image, so nothing goes stale on the next tag. The Hub page's Tags and footer now mirror Snowglobe's. Re-gated: README 0.92, Hub page 0.921, no Critical findings. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ETWOYA
previously approved these changes
Oct 8, 2026
Resolves the add/add conflict on DOCKERHUB.md from #2 by keeping the gated version from this branch, which is the text now live on Docker Hub. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
dankoverride
dismissed
ETWOYA’s stale review
October 8, 2026 21:36
The merge-base changed after approval.
ETWOYA
approved these changes
Oct 8, 2026
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.
Rewrites the README against the code and adds
DOCKERHUB.md, the canonical source for the Docker Hub overview. Supersedes theDOCKERHUB.mdin #2, which repeats the original README's errors.README: what was wrong
GET/HEADplus the gRPC health check. "Any OTLP backend" is OTLP over gRPC only. "Repeat-safe by default" implied an override that does not exist.-results,-versionand-manifest -were missing; the-headersdefault was shown as the env var (it is empty, with an env fallback).README: what was added
immersivefusion/parallaximage, and building from source. No version numbers: release links use/releases/latestand commands use the untagged image, mirroring Snowglobe, so nothing goes stale on the next tag.examples/shop.yamldry run and a-once -results jsonlpass, both captured from runs.run.maxCallsPerSecondis an average checked at plan build, not a throttle.pathmatches the route path only, not any path insidebaseURL.baseURLare sent as Basic auth and printed as-is./healthzreports Parallax's own health, not your services'..img/banner.jpg.Not changed here (code, for the engine owner)
-onceexits 0 when cancelled mid-pass (internal/runner/runner.go:83-86,cmd/parallax/main.go:158-161). A cancelled CI job can read as a pass. The README discloses it until it is fixed.internal/plan/plan.go:112) reads as a guarantee. The README glosses it as theowned: trueguardrail.examples/gate-target.yamlandscripts/propagation-check.sh.Verification
SHA256SUMS, and it printsparallax v0.1.0.immersivefusion/parallax:0.1.0:docker run ... -dry-runexits 0.imagetools inspectshows provenance and an SPDX SBOM on both platforms.After merge (by hand)
DOCKERHUB.mdonto Docker Hub, from the# Parallaxline down.🤖 Generated with Claude Code