Skip to content

docs: explain macOS PATH activation - #232

Open
yassinsolim wants to merge 1 commit into
spicetify:mainfrom
yassinsolim:docs/macos-path-activation
Open

docs: explain macOS PATH activation#232
yassinsolim wants to merge 1 commit into
spicetify:mainfrom
yassinsolim:docs/macos-path-activation

Conversation

@yassinsolim

@yassinsolim yassinsolim commented Aug 6, 2026

Copy link
Copy Markdown

Summary

  • explain that the recommended macOS shell installer updates the user's shell profile
  • tell users to open a new terminal for the updated PATH to take effect
  • document source ~/.zshrc for immediate use in the current zsh session

This complements spicetify/cli#3903, which improves the installer's completion message.

Verification

  • bun run format:check
  • bun run lint
  • bun run build
  • rendered the Getting Started page and confirmed the note appears under macOS → Shell Script

Summary by CodeRabbit

  • Documentation
    • Added macOS installation guidance explaining how to apply the updated PATH.
    • Instructed users to open a new terminal or reload their shell profile after installation.

@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 82406764-934a-47c2-874b-6bfb1d471709

📥 Commits

Reviewing files that changed from the base of the PR and between d38162a and 597a2da.

📒 Files selected for processing (1)
  • src/content/docs/getting-started.mdx

Walkthrough

The getting-started guide adds a macOS installation note. The note explains the shell-profile update and shows how to apply the updated PATH.

Changes

macOS installation documentation

Layer / File(s) Summary
Shell profile activation instructions
src/content/docs/getting-started.mdx
The guide explains that the macOS installer updates the shell profile. It instructs readers to open a new terminal or source ~/.zshrc.

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

Poem

A rabbit reads the setup page,
“New shell steps!” I softly say.
Open a terminal fresh and bright,
Or source .zshrc to set things right.
The PATH now hops into the day.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the macOS documentation change about activating the updated PATH.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@yassinsolim

Copy link
Copy Markdown
Author

Hi @afonsojramos — when you have a chance, would you mind reviewing this small macOS Getting Started clarification? It complements spicetify/cli#3903. Thanks!

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.

1 participant