Skip to content

docs: refresh README + stale --help strings for shipped v0.1#18

Merged
aptracebloc merged 1 commit into
developfrom
docs/readme-v0.1-refresh
Jun 3, 2026
Merged

docs: refresh README + stale --help strings for shipped v0.1#18
aptracebloc merged 1 commit into
developfrom
docs/readme-v0.1-refresh

Conversation

@aptracebloc
Copy link
Copy Markdown
Contributor

@aptracebloc aptracebloc commented Jun 2, 2026

Summary

Docs were stale from the Phase-0 era. Now that v0.1 is feature-complete on develop (all phases #148–#153 merged; dataset push covers 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

  • Status: Phase-0 blurb → "v0.1 feature-complete on develop; first release pending"; lists the 9 supported categories and the 2 not-yet (semantic_segmentation blocked on data-ingestors#136, instance_segmentation).
  • Customer experience: dropped "once Phase 5 ships"; install commands flagged as post-tag (build-from-source until v0.1.0).
  • Building from source: Go 1.22 → 1.26 (matches go.mod).
  • Roadmap: all phases ✅; added the modality-widening + test-harness note and a v0.2 "next" list.

--help / output strings (were contradicting the shipped binary)

  • cluster info no longer prints "Ready for tracebloc 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 ./..., and gofmt -s all 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 for semantic_segmentation / instance_segmentation, install commands noted as post-v0.1.0 tag (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 info drops “coming in Phase 3”; dataset and dataset push long help describe the end-to-end jobs-manager flow and multi-category --category support 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.

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>
@LukasWodka
Copy link
Copy Markdown
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.)

@aptracebloc aptracebloc merged commit a661a9a into develop Jun 3, 2026
13 checks passed
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants