Skip to content

docs(readme): declare session tools via [session] packages, not min add --session - #946

Closed
norrietaylor wants to merge 2 commits into
mainfrom
pr/docs-readme-session-fix
Closed

docs(readme): declare session tools via [session] packages, not min add --session#946
norrietaylor wants to merge 2 commits into
mainfrom
pr/docs-readme-session-fix

Conversation

@norrietaylor

@norrietaylor norrietaylor commented Jul 23, 2026

Copy link
Copy Markdown
Member

The host min add command accepts only --runtime, --build, or --task <NAME> (see AddKind in crates/minimal/src/lib.rs). It has no --session flag: that flag exists only on the separate in-sandbox min add helper. The Getting Started quickstarts ran min add --session ... on the host, before min activate, which fails.

This replaces both host-level invocations with the correct flow: after min init, declare the desired session tools by editing the scaffolded [session] packages list in minimal.toml, mirroring the wording in docs/guide/setup.md.

The valid in-sandbox min add comment (agents adding tools dynamically from inside a session) is left untouched.

Note

Update README to declare session tools via the [session] packages list

Replaces the min add --session command pattern in README.md with instructions to edit the scaffolded [session] table in minimal.toml directly. Adds example package lists in comments to show both a minimal and a larger set of session tools.

Macroscope summarized bf1805f.

Summary by CodeRabbit

  • Documentation
    • Updated the Getting Started walkthrough to configure sessions by editing minimal.toml after initialization.
    • Replaced session-add command examples with commented package configuration snippets.
    • Expanded the example tool list to include additional utilities.

…dd --session

The host `min add` command accepts only `--runtime`, `--build`, or
`--task <NAME>`; it has no `--session` flag (that flag exists only on the
in-sandbox `min add` helper). The Getting Started examples ran
`min add --session ...` on the host before `min activate`, which fails.

Replace both host invocations with the correct flow: after `min init`,
declare session tools by editing the scaffolded `[session]` packages list
in `minimal.toml`, mirroring docs/guide/setup.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The README Getting Started walkthrough now instructs readers to edit the generated [session] table in minimal.toml, with explicit package lists in both examples.

Changes

README session setup

Layer / File(s) Summary
TOML session configuration guidance
README.md
The examples replace min add --session commands with commented [session] and packages configuration guidance, including additional tools in the second example.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested reviewers: msample

Poem

I’m a bunny with a TOML tune,
Editing sessions beneath the moon.
Packages hop into their array,
No min add commands hiding there.
README carrots, neat and bright—
Setup now feels just right!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change, but it omits the required Summary/Testing/Checklist structure from the template. Add the template sections ## Summary, ## Testing, and ## Checklist, and include any tests run plus the checklist items.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title is concise, specific, and accurately summarizes the main README change.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

Comment @coderabbitai help to get the list of available commands.

@norrietaylor
norrietaylor marked this pull request as ready for review July 23, 2026 22:54
min init scaffolds [session] packages = ["base", "vim"] and only appends
"git" when .git already exists (crates/op/src/project/init.rs); in these
examples min init runs before git init, so state the scaffolded starting
list explicitly instead of implying the fuller list is generated.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@twitchyliquid64

Copy link
Copy Markdown
Member

We can also make this have parity with the in-sandbox version

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants