Skip to content

docs: Docker Hub overview (DOCKERHUB.md) - #2

Merged
ETWOYA merged 1 commit into
mainfrom
docs/dockerhub-overview
Oct 8, 2026
Merged

ETWOYA merged 1 commit into
mainfrom
docs/dockerhub-overview

Conversation

@dankoverride

Copy link
Copy Markdown
Collaborator

Canonical source for the immersivefusion/parallax Docker Hub Overview, pasted into the Hub page by hand (the Hub description API rejects PATs), exactly as Snowglobe does.

Claims follow the README and the security review: owned is a guardrail, not access control; no phantom claims; keys via the environment, not argv.

🤖 Generated with Claude Code

Canonical source for the immersivefusion/parallax Docker Hub page,
pasted by hand as for Snowglobe.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ETWOYA
ETWOYA merged commit c6fa478 into main Oct 8, 2026
1 check passed
dankoverride added a commit that referenced this pull request 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>
ETWOYA pushed a commit that referenced this pull request Oct 8, 2026
…nner (#3)

* docs: rewrite README against the code, add Docker Hub overview and banner

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>

* docs: drop version pins from README and Docker Hub overview

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>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants