Uh oh!
There was an error while loading. Please reload this page.
docs: fix README Deploy section (Helm not docker), surface in-repo docs - #102
Merged
Conversation
The Deploy section opened with `docker pull tracebloc/client:latest`, but this repo ships a Helm chart — the actual install is `helm install`. External walkthrough URLs (`/local-linux`, `/local-macos`, `/aws`, `/deployment-overview`) didn't match any path in the tracebloc/docs tree, so they 404. The in-repo documentation (`docs/INSTALL.md`, `docs/MIGRATIONS.md`, `docs/migration-tools/README.md`, `client/MIGRATION.md`) was never linked from the README despite being the operational source of truth. Surgical change — the rest of the README stays as-is: - Replace `docker pull` with `helm repo add` + `helm install` (matches docs/INSTALL.md) - Call out chart version (v1.3.1) and platform support (AKS / EKS / bare-metal / OpenShift) up front - Table linking every in-repo operational doc - Fix external URLs to match actual tracebloc/docs paths (local-deployment-guide-linux, local-deployment-guide-macos, eks-client-deployment-guide, azure-deployment-guide) - Pull NetworkPolicy/CNI prerequisite into a callout Closes#101 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
divyasinghds
approved these changes
May 6, 2026
Uh oh!
There was an error while loading. Please reload this page.
This was referenced May 6, 2026
3 tasks
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 freeto 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
docker pull tracebloc/client:latestwith the correcthelm repo add+helm installflow — this repo ships a Helm chart (client/Chart.yamlv1.3.1), not a Docker image.docs/INSTALL.md,docs/SECURITY.md,docs/MIGRATIONS.md,docs/migration-tools/README.md,client/MIGRATION.md. Previously none of these were discoverable from the README.local-deployment-guide-linux,local-deployment-guide-macos,eks-client-deployment-guide,azure-deployment-guide).Surgical change: tagline, architecture diagram, "What the client manages" list, Security section, Links, and License all stay as-is.
Closes#101
Test plan
helm repo add tracebloc https://tracebloc.github.io/clientactually serves a chart index (filed as a separate follow-up if not)Out of scope (separate follow-ups worth filing)
docs/INSTALL.md:203,220,229still reference the oldtracebloc-helm-chartsrepo nameaks/,bm/,eks/directories at repo roothttps://tracebloc.github.io/client🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes updating Helm install guidance and links; no runtime or configuration behavior is modified.
Overview
Updates the README Deploy section to reflect Helm-based installation (adds
helm repo add/helm installcommands), calls out the unified chart version and supported platforms, and adds a table linking to key in-repo operational docs (install, security, migrations, and runbooks).Fixes and consolidates platform-specific walkthrough links and adds a prominent NetworkPolicy/CNI prerequisite callout pointing to
docs/SECURITY.md.Reviewed by Cursor Bugbot for commit a610d2f. Bugbot is set up for automated code reviews on this repo. Configure here.