Repository navigation
docs(concepts): add the sessions concept guide - #939
Conversation
Author a user-facing concept guide for Minimal sessions: what a session is and why, the provider/session model, creating and entering one, composition from project config plus loadouts, lifecycle, and how sessions relate to sandboxes and tasks. Grounded in the min CLI surface and the architecture docs. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
📝 WalkthroughWalkthroughAdds a documentation page defining Minimal sessions, providers, activation and attachment, composition and policy handling, lifecycle commands, and the relationship between sessions, sandboxes, and tasks. ChangesSessions documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
Comment |
The command channel accepts only mi 8000 n run invocations, project files are an uploaded workspace copy (git push min:// brings changes back), lifecycle hook execution is not yet wired, provider stop keeps session records, and the sandbox persists across detach. Also covers detach explicitly and drops the redundant trailing path from the activate example, per review. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/concepts/sessions.md`:
- Around line 196-204: Update the `min stop` documentation to describe stopping
the active provider rather than calling `minimald` the provider daemon. Use
platform-neutral wording throughout this paragraph, and mention that `minimald`
or `minvmd` may be the provider implementation only where needed to clarify the
distinction.
- Around line 7-11: Revise the session terminology throughout this guide,
including the definition and the sections around the later
session-versus-sandbox references, so a session is consistently described as the
durable provider-managed object. Describe the sandbox as the execution and
isolation context that the session owns or launches, and remove wording that
presents the session itself as the sandbox or explicitly denies that
relationship.
- Around line 61-62: Update the command examples in sessions.md, including the
min activate --attach block and the additional cited examples, to resolve MD014
by removing shell prompts and using command fences or adding representative
output. Keep the commands and documentation meaning unchanged so markdownlint
passes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f91f5446-1b11-40c6-81ae-97a5dd9a887b
📒 Files selected for processing (1)
docs/concepts/sessions.md
There was a problem hiding this comment.
LGTM caveat comments
- mention detach in the intro - introduce loadouts in 'Why sessions' as the personal-tooling vector - note loadouts contribute to the shell, never to tasks - make session-vs-sandbox terminology consistent (session = durable environment; sandbox = execution context) - describe current networking caveats: own-ip unavailable on the native Linux provider, macOS host-net outbound-only - correct the lifecycle-hooks status after #975: project hooks composed but never executed, loadout hooks excluded from composition - platform-neutral wording for min stop Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
New user-facing concept guide for Minimal sessions (provider/session model, activation/attach, composition from project config plus loadouts, lifecycle, and the session/sandbox/task relationship). Cross-links to
../reference/cli-min.mdand./loadouts.mdcurrently dangle and resolve once #863/#868 (loadouts) and the CLI reference land. Verification done: no em-dashes, no "harness"/"profile", no private-repo name, repo-relative .md links, everymincommand exists in the CLI.Note
Add sessions concept guide to Minimal documentation
Adds sessions.md, a new concept guide covering the Minimal sessions model. The guide explains the provider architecture (
minimald,minvmd), session lifecycle commands (min activate,min attach,min ls,rename,destroy,stop), composition from project config and loadouts, and the relationship between sessions, sandboxes, and tasks.Changes since #939 opened
min run <task name>invocations via--command/-cflag, requiring arbitrary commands to use an interactive shell [da0354f]min activateincluding--attachand--no-promptbehavior [da0354f]min stopcommand description to indicate it stops the active provider rather than specificallyminimald, with sessions persisting across provider restarts [b7e0fee]Macroscope summarized f31e6f3.
Summary by CodeRabbit