Repository navigation
docs(guide): rewrite getting started as a command-first quickstart - #3259
norrietaylor wants to merge 5 commits into
Conversation
Six steps, one command each: install, min init, min add --session claude, activate, run the agent, list/attach/destroy.
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
|
claude installs Claude Code plus its Minimal plugin. Also clears the file's Vale alerts.
| The `claude` package is Claude Code plus the Minimal plugin for it. | ||
|
|
||
| ## 4. Start a box | ||
|
|
There was a problem hiding this comment.
This should use BCLI commands and reuse the glossary terms
There was a problem hiding this comment.
Done in 8d39e29. Steps 4 and 6 now use min session start, min box list, min box attach and min box rm, all BCLI commands already on main. None of the session verbs that BCLI-042 removes are left. The first use of box, stack, minimal.toml, package and session each links to its glossary entry. The glossary itself now says min box exec and local (b56dbd2).
min session start, min box list, min box attach and min box rm replace the session verbs BCLI-042 removes. First uses link to the glossary.
There was a problem hiding this comment.
Read at 8d39e29, each of the six commands checked against the CLI on main and the package against the registry.
Every command is one a person can type today. min init prompts before it writes only on a terminal not told --no-input, which is what "It asks before it writes" says for the person at a terminal. min add --session claude is --session on AddArgs, and packages/claude exists in gominimal/pkgs beside the older claude-code, so switching docs/guide/agents.md to claude makes the two pages name the one package. min session start is the BCLI verb on main (T40 landed the override flags on it this week). min box list, min box attach with no argument ("omit it to attach to this project's box") and min box rm <box> [--force] are as the page shows them, --force included for a running box.
The rewrite does what it says. Six steps with one command each, the first use of each term linked to the glossary (#3258), three "next" links, and the agents.md sentences rewritten to zero Vale alerts without changing what they allow: the credential paragraph still says to pass the minimum and that activation gates each inherited value and patch against the user policy.
One note, not blocking: step 4 says the packages from step 3 are on the box's PATH; min add --session edits [defaults.session], so a project whose minimal.toml already has a session entry with its own packages gets them there, which is the same outcome; fine as written for a fresh min init.
What
Rewrites
docs/guide/getting-started.mdfrom three paragraphs of product description into six steps with one command each:min initmin add --session claudemin session startclaudemin box list/min box attach/min box rmThe steps use only BCLI commands that are already on main (
min session start,min box list|attach|rm), not the session verbs that BCLI-042 removes. The first use of each term links to its glossary entry. The full docs update waits for BCLI to land.It ends with at most three "next" links.
Also switches
docs/guide/agents.mdfromclaude-codetoclaude, so the two pages name the same package. The other sentences flagged by Vale in that file are rewritten so it has zero alerts. Its "session" wording stays until the guide rewrite.Stacked on the glossary PR because it links to the glossary; the base retargets to
mainwhen that PR merges.Why
User feedback: the docs are "walls of text" that point back and forth between large pages. The old getting-started page had no command on it, and the first runnable command was in
setup.md, after a long explanation ofminimal.toml.Verification
just lint-prose docs/guide/getting-started.md docs/guide/agents.md: 0 alerts.claudepackage is a metapackage that installsclaude-codeandclaude-code-minimal-plugin(gominimal/pkgspackages/claude/build.ncl).Not yet verified, so this stays a draft until they are checked:
min initstill writes the old[session]table name, and release 0.8 prints a hint each time it reads it. A new user will see that hint on the first activate.min add --sessionwrites to the table thatmin initcreated.