Skip to content

docs(README.md,ref-docs/cli-min.md): - #1100

Merged
msample merged 1 commit into
mainfrom
mike/docs-readme
Jul 30, 2026
Merged

docs(README.md,ref-docs/cli-min.md): #1100
msample merged 1 commit into
mainfrom
mike/docs-readme

Conversation

@msample

@msample msample commented Jul 30, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Summary

  • update examples to clean up authz
  • update curl|bash installer download URL to use stable brnach (bare host default)
  • update Loadout example to be more complete
  • add missing --session option to min add docs

Testing

Renders well enough in my editor's markdown mode

Checklist

  • [x ] Docs updated if behavior changed (docs updated, no behavior change)
  • BREAKING CHANGE: footer present if this is a breaking change (no breaking change)

Note

Update README install commands and walkthrough docs to use stable channel

  • Updates install/uninstall commands in README.md to use https://go.minimal.dev/ instead of the previous unstable endpoint.
  • Rewrites shell walkthrough steps for GitHub PAT creation, macOS Keychain storage, and GH_TOKEN export within sandbox sessions.
  • Extends the sample loadout TOML with a patches array, VISUAL var, and a lifecycle_hooks on_activate command to warm the Helix grammar cache.
  • Adds --session to the mutually exclusive option group in the min add usage synopsis in cli-min.md.

Macroscope summarized 504558c.

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions with the stable installer endpoint, stable-channel guidance, and revised uninstall steps.
    • Expanded project setup guides with credential-free GitHub workflows using fine-grained personal access tokens.
    • Updated existing-project guidance and sandbox command examples.
    • Added documentation for the min add --session option.
    • Refreshed sample loadout configuration with editor settings, dotfile patches, and lifecycle hooks.

@msample
docs(README.md,ref-docs/cli-min.md): update examples, installer downl…
504558c 
…oad URL to use stable, update loadout to be more complete, add missing option to min-add docs
@msample
msample requested a review from a team as a code owner July 30, 2026 01:22
@coderabbitai

coderabbitai Bot commented Jul 30, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

README onboarding, sandbox credential workflows, loadout configuration examples, badges, and the min add --session CLI reference are updated.

Changes

Documentation updates

Layer / File(s) Summary
Onboarding and installation documentation
README.md		 Badges use centered HTML elements, and installation and uninstall instructions use the stable installer endpoint.
Sandbox credential workflows
README.md		 Project walkthroughs document keychain-backed GitHub PAT usage and session-specific credential injection.
Loadout configuration example
README.md		 The sample loadout adds Helix and Zellij patches, editor variables, and a Helix cache activation hook.
CLI selector reference
docs/reference/cli-min.md		 The min add synopsis documents --session alongside the existing selectors.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related issues

  • gominimal/inbox#421 — Covers the min add --session documentation gap addressed here.

Possibly related PRs

Suggested reviewers: norrietaylor

Poem

A rabbit reads the guide at dawn,
With badges bright and shells to spawn.
A token tucked where keychains keep,
Lets sandboxed projects safely leap.
Helix warms its trees anew—
“Hop along, the docs are through!”

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is incomplete and effectively blank after the scope, so it does not clearly summarize the change. Use a concise conventional-commit subject like docs: update README install flow and cli-min docs.
✅ 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.
Description check ✅ Passed The description includes Summary, Testing, and Checklist sections and covers the main doc updates.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mike/docs-readme

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

@msample
msample merged commit d354959 into main Jul 30, 2026
27 of 29 checks passed
@msample
msample deleted the mike/docs-readme branch July 30, 2026 01:26
@coderabbitai coderabbitai Bot mentioned this pull request Jul 30, 2026
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@twitchyliquid64 twitchyliquid64 twitchyliquid64 approved these changes
+1 more reviewer
@jtnk jtnk jtnk approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@msample @twitchyliquid64 @jtnk