Rewrite the README and fix inaccurate generated docs and workbench hints - #45
Merged
Conversation
Nearly every command the generator emitted omitted the `chronicle` group — `cratis observers list` rather than `cratis chronicle observers list` — so an agent following the document got "Unknown command". Two commands did not exist at all: `cratis config show` (there is no config group) and `cratis events has`. CHRONICLE.md is written into a project by `cratis init` and read by AI tools as ground truth, which makes a wrong command worse than no guidance. Also replaces an unsourced "up to 34x fewer tokens" claim about plain output with the measured 4-5x, and points connection troubleshooting at `cratis chronicle diagnose`. The accompanying spec scans the generated text for any Chronicle sub-branch appearing without its group, so the class of mistake cannot come back. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
NavigateTo is what selects a nav item and renders its view, and it was guarded behind a restored index greater than zero. A first-ever session — or any session last closed on Overview — therefore opened to an empty pane and stayed that way until the first keypress. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The Overview panel told users to "press 3" and "press 5" to reach failures and recommendations, and the command's LlmDescription told agents to navigate with number keys 1-9. No number key is bound in WorkbenchKeyDispatcher. The hints now name the sidebar entries, and the description lists the keys that do exist. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
There was no way to stop the CLI reaching NuGet and closing commands with "update available". That notice is noise in a cron log, in CI, and in a recorded terminal session, and the only workaround was pre-dating the cache the check consults — a hack aimed at the wrong layer. Set the variable to any non-empty value and the check returns without a request. Agent environments already suppressed the hint; this covers everyone else. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The README opened with an installation list and left the reader to work out what the tool is for. It now opens with the situation that sends someone to it: a read model that looks wrong, where the derived state and the reason for it live in two different places and a stalled observer is indistinguishable from an idle one. Also fixes the Linux install command, which fetched `latest/download/cratis-linux-x64.tar.gz`. Release assets carry the version in the filename, so that URL has been returning 404. Every command, figure and block of output in the new text was produced by running the CLI, including the output-format byte counts. Adds three recorded GIFs and the harness that produces them. assets/demo-store builds a throwaway Chronicle in Docker and seeds a bookshop with one reactor partition deliberately failing, so the recordings have something real to show without pointing a camera at anyone's system. Identifiers are deterministic and the tapes are committed, so the set re-renders from a clean checkout. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Collaborator
Author
|
Reviewer notes — not release notes. Verification. The Recording harness. Known, not addressed here:
|
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.
Summary
README rewrite, plus fixes to generated docs and workbench hints that referenced commands and keys that do not exist.
Added
CRATIS_NO_UPDATE_CHECKdisables the update check.Changed
CHRONICLE.mdpoints connection troubleshooting atcratis chronicle diagnose.Fixed
CHRONICLE.mdwere missing theirchroniclegroup and failed with "Unknown command".cratis config showandcratis events haswere referenced in generated docs but do not exist.