Skip to content

Use $HOME variable for prefs_path in documentation#200

Open
Celestial04 wants to merge 1 commit intospicetify:mainfrom
Celestial04:main
Open

Use $HOME variable for prefs_path in documentation#200
Celestial04 wants to merge 1 commit intospicetify:mainfrom
Celestial04:main

Conversation

@Celestial04
Copy link

@Celestial04 Celestial04 commented Feb 14, 2026

$HOME is used for completing /home/<username>/ to be like /home/celeste for example.

Summary by CodeRabbit

  • Documentation
    • Updated Flatpak setup instructions to use environment variables for configuration paths. Configuration paths now dynamically adapt to your system environment instead of relying on hardcoded references, improving portability and compatibility across different system configurations.

@coderabbitai
Copy link

coderabbitai bot commented Feb 14, 2026

Walkthrough

Updated the Flatpak setup documentation to use the $HOME environment variable instead of a hardcoded /home/username path for the prefs_path configuration value, making the setup more portable across different user environments.

Changes

Cohort / File(s) Summary
Documentation Update
docs/getting-started.md
Updated Flatpak setup notes to replace hardcoded home path with $HOME environment variable for improved portability.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A path that's hard is set in stone,
But variables help us roam back home!
With $HOME we've made it right,
Now every burrow shines so bright! 🌟

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: updating documentation to use the $HOME environment variable instead of hardcoded paths for the prefs_path configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

No actionable comments were generated in the recent review. 🎉

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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 and usage tips.

Copy link
Author

@Celestial04 Celestial04 left a comment

Choose a reason for hiding this comment

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

seem good

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