Skip to content

docs(guide): lift the getting-started, install, and setup guides - #941

Merged
norrietaylor merged 5 commits into
mainfrom
pr/docs-guide-start
Jul 27, 2026
Merged

norrietaylor merged 5 commits into
mainfrom
pr/docs-guide-start

Conversation

@norrietaylor

@norrietaylor norrietaylor commented Jul 23, 2026 •

Copy link
Copy Markdown
Member

Lift the Start pages (getting-started, install, setup) into docs/guide/, de-numbered and GitHub-first: em-dashes removed, harness renamed to stack ([stack] TOML block, verified against mfile), package/build commands mapped to mip (init/update/--version), and the install guide uses the stable channel (https://go.minimal.dev/stable) in every install command. No profiles content, no private repo names. Cross-links resolve once #863 and sibling docs-lift PRs merge; verification greps (em-dash, harness/profile/unstable, root-relative doc links) all clean.

Note

Add getting-started, install, and setup guides to the Minimal docs

Adds three new documentation pages to the guide section covering the full onboarding flow for Minimal.

  • getting-started.md introduces what Minimal is and links to a download.
  • install.md covers system requirements and the curl-based installer for Linux (x86_64/aarch64) and macOS on Apple Silicon.
  • setup.md explains min init, the minimal.toml config structure, and how to enter a session with min activate --attach ..

Changes since #941 opened

  • Updated installation requirements documentation [a33e616]
  • Added installation lifecycle management documentation [a33e616]
  • Updated project initialization and configuration documentation [a33e616]
  • Updated session activation sandbox behavior description [a33e616]
  • Wrapped frontmatter description value in double quotes [a33e616]

Macroscope summarized 82ef622.

@coderabbitai

coderabbitai Bot commented Jul 23, 2026 •

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 53 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 876ecc8f-5016-4e1a-bc9d-2ff2c60fcfdc

📥 Commits

Reviewing files that changed from the base of the PR and between 7fd582e and a33e616.

📒 Files selected for processing (3)
  • docs/guide/getting-started.md
  • docs/guide/install.md
  • docs/guide/setup.md

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

norrietaylor and others added 3 commits July 23, 2026 12:50
The installer puts `min` on PATH (per the README), so the post-install
sanity check should use the session CLI's `min --version`, not `mip`.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the mip-centric init/update walkthrough with the session-first flow:
`min init` scaffolds minimal.toml (including the `[session]` block it really
generates), declare the session's tools in that block, then `min activate
--attach .` to create and enter an isolated session. Uses `min` throughout,
per the session-first product framing.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@norrietaylor
norrietaylor marked this pull request as ready for review July 23, 2026 21:41
Comment thread docs/guide/setup.md Resolved
Comment thread docs/guide/install.md Resolved
Comment thread docs/guide/setup.md
Edit the `packages` list under `[session]` to add whatever your team works with. Extend the existing list; do not add a second `[session]` table, since TOML does not allow a table to be defined twice.

```toml
[session] # min attach

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should the comment be min activate instead? I see this in the init toml file also

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TBH; at a glance this comment doesn't seem very helpful

Quote the getting-started frontmatter description, require unprivileged user
namespaces with a linux-host-setup link, align the macOS floor with the README
(Apple Silicon, M1 or later), describe activation as seeding the sandbox with
a project copy, note the min init confirmation prompt and the pip/uv stack
names, explain [defaults], and add Upgrade and Uninstall sections per review.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@norrietaylor
norrietaylor merged commit 5135d9c into main Jul 27, 2026
29 checks passed
@norrietaylor
norrietaylor deleted the pr/docs-guide-start branch July 27, 2026 18:45
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.

3 participants