docs: reorganize the README so a stranger can install without a wall of text - #15
Closed
lucy-wolfe wants to merge 5 commits into
Closed
docs: reorganize the README so a stranger can install without a wall of text#15lucy-wolfe wants to merge 5 commits into
lucy-wolfe wants to merge 5 commits into
Conversation
…ng past a lecture What it is in two sentences, the animation, install, and the first company now lead the page. Depth moved into short skimmable sections or linked docs: the crate table went to docs/ARCHITECTURE.md, which already carries it, and the long GIF caption and quick-start asides were trimmed. New: an Everyday commands table, derived from the routed operator verbs in chief-cli's OPERATOR_VERBS, and a Contributing section naming the two open workstreams (finishing apps/web, and multi-machine hosting so one busy company stops pegging a single box's CPU) plus the issue tracker and CONTRIBUTING.md. Every command documented was checked against install.sh and the routed verb table. The Pi floor line keeps Pi and 0.80.10 on one line for pi-floor-single-definition.test.mjs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TMNbixeJo8rpeijUKyxhD2 Signed-off-by: Lucy Wolfe <lucy@zbox.sh>
The installer already edits the shell profile and reports exactly which file it touched, so the extra line was a second copy of work the script does itself. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TMNbixeJo8rpeijUKyxhD2 Signed-off-by: Lucy Wolfe <lucy@zbox.sh>
The animation speaks for itself; the recording provenance note is not needed on the front page. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TMNbixeJo8rpeijUKyxhD2 Signed-off-by: Lucy Wolfe <lucy@zbox.sh>
Three steps a stranger can paste in order: Pi, chief, first company. The Pi floor stays on one line with the name for the pi-floor guard. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TMNbixeJo8rpeijUKyxhD2 Signed-off-by: Lucy Wolfe <lucy@zbox.sh>
Step 3 says what the first run is (Founder, two questions, then the CEO boots) and step 4 says what every later run is (the same bare chief starts and attaches the company). The transition is the part a stranger cannot guess from the command alone. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TMNbixeJo8rpeijUKyxhD2 Signed-off-by: Lucy Wolfe <lucy@zbox.sh>
Contributor
Author
|
Superseded by #16, which merges this branch together with the other two changes so |
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 this changes
Only
README.md. The page now leads with what chief is in two sentences, the recorded demo, the install command, and the first company. Depth follows in short skimmable sections or moves to the docs that already carry it.Reorganized
panels.castrecording still linked.OPERATOR_VERBSinchief-cli/src/main.rs):ls,attach,stop,stand-down,resume,reset,rm,upgrade.actuateandtopologystay indocs/OPERATING.md, which the section links for the full surface.docs/ARCHITECTURE.md. The crate-by-crate table was removed from the README because that doc already owns it.apps/web, described honestly per its own README (real Next.js code and CI-run unit suites, but it does not build a working host today and ships in nothing a user installs);Plus links to the issue tracker and
CONTRIBUTING.md.Verified while writing
install.sh, and the Pi floor line keepsPiand0.80.10on one line, whichscripts/test/pi-floor-single-definition.test.mjsrequires of this file.chief <verb>claim is in the routed verb set thatscripts/test/model-facing-copy.test.mjsderives at run time.docs/*.mdfiles linked from the README is unchanged, so the doc sweep's enrolled surface is unchanged.🤖 Generated with Claude Code
https://claude.ai/code/session_01TMNbixeJo8rpeijUKyxhD2