docs: refresh README + stale --help strings for shipped v0.1#18
Merged
Conversation
README was stuck at Phase 0; updates Status (9/10 modalities), Customer-experience/install caveats, Go 1.26 floor, and the roadmap. Also fixes three user-facing help/output strings (cluster info 'coming in Phase 3'; dataset and dataset push --help referencing Phase 4 / PR-b / image-only) that contradicted the shipped binary. Docs only. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
👋 Heads-up — Code review queue is at 23 / 8 Above the WIP limit. The team convention is to review existing PRs before opening new work. Open PRs currently in Code review (oldest first):
Pull from review before opening new work. (This is a nudge from the kanban WIP check, not a block.) |
This was referenced Jun 2, 2026
LukasWodka
approved these changes
Jun 3, 2026
This was referenced Jun 3, 2026
aptracebloc
pushed a commit
that referenced
this pull request
Jun 3, 2026
The root command's Long help still claimed the binary "implements only version and completion" and pointed at the roadmap for future phases — stale since v0.1 shipped the dataset/ingest/cluster commands. PR #18 refreshed the README and the three other user-facing --help strings but missed this one (it scoped to cluster info / dataset / dataset push). Describe the shipped command set instead. Docs/strings only; no behavior change. Closes #19 Co-authored-by: Claude Opus 4.8 <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.
Summary
Docs were stale from the Phase-0 era. Now that v0.1 is feature-complete on
develop(all phases #148–#153 merged;dataset pushcovers 9 of 10 modalities), this refreshes the README and the three user-facing--help/output strings that still referenced unshipped phases. Docs/strings only — no behavior change.README
develop; first release pending"; lists the 9 supported categories and the 2 not-yet (semantic_segmentationblocked on data-ingestors#136,instance_segmentation).v0.1.0).go.mod).--help/ output strings (were contradicting the shipped binary)cluster infono longer prints "Ready fortracebloc dataset push(coming in Phase 3)."dataset --help: dropped "submission … lands in Phase 4 / picked up by the helm flow" → describes the shipped stage + submit + watch flow.dataset push --help: "image_classification dataset … (in PR-b)" → category-agnostic, notes the 9 categories +--category.Verification
go build,go vet ./...,go test ./..., andgofmt -sall clean.🤖 Generated with Claude Code
Note
Low Risk
Documentation and user-facing strings only; no functional or security-sensitive code paths changed.
Overview
Updates documentation and user-facing copy so they match v0.1 feature-complete on
develop—no runtime behavior changes.The README now describes shipped status instead of pre-alpha Phase 0: full
dataset push(stage → submit → watch), 9 of 10 task categories with explicit gaps forsemantic_segmentation/instance_segmentation, install commands noted as post-v0.1.0tag (build from source until then), Go 1.26 in build instructions, and a roadmap table with all phases ✅ plus a short v0.2 “next” section.CLI help and output are aligned with the binary:
cluster infodrops “coming in Phase 3”;datasetanddataset pushlong help describe the end-to-end jobs-manager flow and multi-category--categorysupport instead of image-only / future-phase wording.Reviewed by Cursor Bugbot for commit fd7844a. Bugbot is set up for automated code reviews on this repo. Configure here.