docs(cli): document the describe command in the design - #329
Draft
rogirun wants to merge 1 commit into
Draft
Conversation
rogirun
force-pushed
the
docs/cli-describe
branch
from
September 6, 2026 12:59
80c39eb to
bf77f81
Compare
rogirun
force-pushed
the
feat/cli-describe-file-mode
branch
2 times, most recently
from
September 7, 2026 10:43
c17c138 to
a7e281c
Compare
rogirun
force-pushed
the
docs/cli-describe
branch
from
September 7, 2026 10:43
bf77f81 to
3a2c2ac
Compare
Replace the workload tree, status and resources sketches with describe, which supersedes all three: they answered three parts of one question, and a reader who ran one usually wanted the others. Bring the rest of the document in line with what shipped. The command grammar is verb-first, not two top-level nouns. Pod matching is two stages, not one: selectors say which role a pod plays and ownership says which workload it belongs to, and the PodMatcher interface sketched here was never the shape that worked. WorkloadView is the struct describe emits, with a note on why the "3/4" ReadyCount it used to declare was rejected. Refs #206 Signed-off-by: Roee Gil <roee.gil@run.ai>
rogirun
force-pushed
the
feat/cli-describe-file-mode
branch
from
September 7, 2026 12:20
a7e281c to
e93d041
Compare
rogirun
force-pushed
the
docs/cli-describe
branch
from
September 7, 2026 12:20
3a2c2ac to
b8788ba
Compare
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
1 participant
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.
What does this PR do?
Replaces the workload tree, status and resources sketches with describe, and brings the design document in line with what shipped: verb-first grammar, two-stage pod matching, and the WorkloadView struct describe emits.
Part of a seven-PR stack implementing
kli describe(#206). Targetsfeat/cli-describe-file-mode, which must merge first.Related issue(s)
Refs #206
Checklist
git commit -s)make check)🤖 Generated with Claude Code