Docs: cover the CLI surface in the 0.15.0 release notes - #98
Merged
Merged
Conversation
The release notes described the engine well and the command line barely. A CLI user scanning them could not answer "what can I type now?" Diffing the command surface against v0.14.3 found four new commands, only three of which were named. /compact was described as a capability — "conversations can be compacted on demand" — without ever saying the command, which is the one detail a CLI user needs. It now names it and says how it differs from /clear, since the two are easy to confuse and one of them is destructive. Adds a New & changed slash commands table, matching the one this file used at 0.11.0, so the whole command surface is scannable in one place. Two more gaps found the same way: The planner and plannerEngine config keys are retired — /config now refuses them because the workflow planner is the only execution path. Anyone who set them, or who has them in a config file, meets that with no warning in the notes. Verified that a config file still carrying them loads fine: reads do not set UnmappedMemberHandling, so unknown keys are ignored rather than rejected. The startup banner keeps a prerelease tag now, so a test build no longer looks identical to the release it was cut from. Entry count 32 to 35; the two that appear to have gone are the compaction and migration entries, both reworded in place.
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
Adds the CLI's own surface to the 0.15.0 release notes. These changes were written for #97 but
landed a minute after it merged, so they missed the release section entirely — this carries them
onto
mainon top of it.Documentation only. One file, +24 / −3.
Why this matters
The 0.15.0 notes describe the engine thoroughly and what a user actually types barely. Someone
reading them to find out what is new in the command line could not answer "what can I type now?"
Diffing the command surface, config keys and CLI flags against
v0.14.3— rather than working frommemory — turned up three gaps:
/compactwas never named. It appears only as a capability: "conversations can be compactedon demand." For a CLI release, the command is the feature. It now also says how it differs
from
/clear, since the two are easy to confuse and one of them is destructive.planner/plannerEnginesettings went unmentioned./configrefuses them now,because the workflow planner is the only execution path. Anyone who had set them would have met
that with no warning in the notes.
v0.16.0-rc.1no longer displays as plain
v0.16.0— previously a test build and the release it was cut fromlooked identical, which is exactly when a stale binary is hardest to spot.
What changed
New & changed slash commandstable, matching the format this file used at 0.11.0, so thewhole surface is scannable in one place:
/plan <goal>,/plan-resume,/plan-discard,/compact, and the/configkeys that are gone./compactand contrasts it with/clear.recovering after a crash does not require remembering a command.
Scope and risk
Low. Markdown under
docs/, inside the already-dated[0.15.0]section. Nothing compilesfrom it.
The one thing worth a reviewer's eye is that this edits a released section. The version is dated
but not yet tagged and not on NuGet, so the notes are still accurate to describe what will ship. If
you would rather freeze
[0.15.0]as merged and carry these into 0.15.1, that is a reasonable calland this can be retargeted.
Verification
v0.14.3: four commands added (/plan,/plan-resume,/plan-discard,/compact), none removed. No CLI flags changed either way. Two config keysadded, both as refusals.
planneris not an error. Config reads do not setUnmappedMemberHandling, so System.Text.Jsonignores unknown keys rather than throwing. Also confirmed
strictPlanVerificationis gone fromsrc/entirely, not merely undocumented.that appear to vanish are the compaction and migration entries, both reworded in place.
Not covered: no test run — nothing here is code, and the 733/733 figure in the Test coverage
section is unchanged and was measured on the release branch. Whether each pre-existing entry still
describes its feature accurately was settled in #96 and is untouched here.
Note on history
The commit is the one written for #97. It is unchanged apart from being rebased onto the merge.
#97's body was edited to describe this work after it had already merged, so that description does
not match what #97 actually contains — this PR is where it really lands.