Add spicetify config instructions to getting started #194
Conversation
Added instructions for configuring spicetify path based on shell type.
WalkthroughDocumentation update to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/getting-started.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/getting-started.md
99-99: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (1)
docs/getting-started.md (1)
105-117: Content and approach look good.The shell detection approach is standard, and the provided commands are accurate:
- zsh and bash PATH exports use the correct RC file and syntax
- fish uses
fish_add_path, which is the idiomatic way to add to PATH in fish (no manual source needed)The section integrates well with the existing Linux-specific setup documentation.
| <details> | ||
| <summary>Setting spicetify config to path</summary> | ||
|
|
||
| Determine your shell | ||
|
|
||
| ``` | ||
| echo $SHELL | ||
| ``` | ||
|
|
||
| Depending on if it says `/bin/zsh` `/bin/bash` `/usr/bin/fish` use the following commands based on that. | ||
|
|
||
| ```zsh | ||
| echo 'export PATH=$PATH:~/.spicetify' >> ~/.zshrc | ||
| source ~/.zshrc | ||
| ``` | ||
|
|
||
| ```bash | ||
| echo 'export PATH=$PATH:~/.spicetify' >> ~/.bashrc | ||
| source ~/.bashrc | ||
| ``` | ||
|
|
||
| ```fish | ||
| fish_add_path ~/.spicetify | ||
| ``` | ||
| </details> |
There was a problem hiding this comment.
Add language identifier to shell detection code block.
The code block at line 99 is missing a language identifier, which violates the Markdown linting rule MD040. Specify the language (e.g., bash or console) to fix the lint error.
🔎 Proposed fix
Determine your shell
-```
+```bash
echo $SHELL</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
<details>
<summary>Setting spicetify config to path</summary>
Determine your shell
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
99-99: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In docs/getting-started.md around lines 94 to 118 the first fenced code block
(the shell detection echo $SHELL) lacks a language identifier which triggers
MD040; update that fence to include a language (e.g., bash or console) so the
block starts with ```bash (or ```console) to satisfy the linter while leaving
the block contents unchanged.
1 participant
Added instructions for configuring spicetify path based on shell type.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.