spicetify/docs

Documentation website for spicetify

docs's Issues

Edit buttons not working

When a doc is open, the edit button leads to a not found.

Update AUR Linux section

🔍 Have you checked Spicetify.app page for your issue?

• I have checked the FAQ

🔍 Is there already an issue for your problem?

• I have checked older issues, open and closed

ℹ Environment / Computer Info

Not needed.

📝 Description

As per spicetify/cli#70, we should move the "Note" section for AUR to the AUR section.

📸 Screenshots

No response

Suggestion: should I add Spicetify Creator to the docs?

Suggestion: Should I add docs for Spicetify Creator?

I've been working on a project to simplify and modernize the coding process for extensions and custom apps.
Unlike current methods for creating extensions and custom apps, Spicetify Creator allows importing packages, using react typescript syntax, and more.

I think this improves the coding process tremendously and I want to show it to more people.
So if you think this is a good idea I can start creating docs.

Customization page references old config file name

The pre v2 config file was called config.ini, and with v2, it's called config-xpui.ini.

Make items in 'Advanced usage' section top level

📝 Provide a description of the new feature

Hopefully people would read those pages more... I don't have my hopes set very high though

➕ Additional Information

No response

Mention spicetify-nix flake in linux documentation / installation instructions

📝 Provide a description of the new feature

Add the following instructions to https://spicetify.app/docs/advanced-usage/installation/ below the "AUR" and "Homebrew or Linuxbrew" sections:

Home Manager

If your linux installation uses Systemd (Fedora, Ubuntu, and Manjaro all use
Systemd) then you can install the nix package manager and home-manager
in order to manage spicetify. First, to install nix for all users on your
system, run the following command and follow the interactive prompts:

sh <(curl -L https://nixos.org/nix/install) --daemon

More information on nix installation can be found at https://nixos.org/download.html
Then, restart your terminal/shell and run the following command to enter a
shell with home-manager and git installed. We'll be running the rest of these
commands from inside this new shell. Type exit to leave it, if you need.

nix-shell -p home-manager git

Next, run the following commands to make a new home manager configuration for
spicetify in your current directory.

mkdir ~/home-manager-config && cd ~/home-manager-config
nix flake init --template github:the-argus/spicetify-nix --extra-experimental-features nix-command --extra-experimental-features flakes
sed "0,/unknown_username/{s/unknown_username/$(whoami)/}" -i flake.nix
sed "0,/unknown_hostname/{s/unknown_hostname/$(hostname)/}" -i flake.nix
git init --initial-branch=main
git add .
home-manager switch --flake . --extra-experimental-features nix-command --extra-experimental-features flakes

The spotify that's in your path (or the new spotify that appeared in your app
launchers) should now be a spiced version of spotify, complete with dribbblish
and some custom apps and extensions. Run spotify & disown to launch it, or
edit the spicetify.nix file to customize it. If you have any problems, also
check out the README.md file.

➕ Additional Information

Benefits!

My biggest problem with spicetify is how finicky it is with in-place updates. The initial installation works, but everything breaks at any spicetify or spotify update. My nix flake (located here btw) fixes this problem because packages built in nix have no state. That is, they're built and installed fresh every time they update. Additionally, the package automates the tedious process which is currently necessary on linux of setting up the latest CSS map. Overall, I think the experience of using nix is way better than the spicetify cli.

possible issues

What I've written is definitely targeted at newish linux users, and may fail to get points across to intermediate users who may already have nix installed or are on NixOS but don't quite understand what the commands are meant to do. That's a small enough audience that I don't mind, though. They can figure it out, I think.

Update `spicetify-docs` issue templates

🔍 Have you checked Spicetify.app page for your issue?

• I have checked the FAQ

🔍 Is there already an issue for your problem?

• I have checked older issues, open and closed

ℹ Environment / Computer Info

This does not apply.

📝 Description

Most of the sections of the default issue template do not apply. We should create a template specific to documentation.

📸 Screenshots

No response

Broken link on Custom App Page

🔍 Have you checked Spicetify.app page for your issue?

• I have checked the FAQ

🔍 Is there already an issue for your problem?

• I have checked older issues, open and closed

ℹ Environment / Computer Info

- Spotify version: 1.2.34.783
- Spicetify version: 2.36.3

📝 Description

https://spicetify.app/docs/development/custom-apps/
On this page, the CustomApps folder link is broken.

📸 Screenshots

No response

Workflow triggered Algolia Crawler not working

📝 Description

The GitHub Action here is not working yet, which is forcing us to have a scheduled crawl, which is not as ideal as doing it when we push.

The workflow is already deployed, however it is failing as it can be seen here.

Currently trying to understand why it is failing here: algolia/algoliasearch-crawler-github-actions#201

Simplify installation process

As a first time user, the installation page can seem a bit daunting.

We should simplify it as best as we can to present the single command for both platforms.

Mobile app

📝 Provide a description of the new feature

Please bring this thing to mobile. Most of the people are mostly comfortable with mobile and use mobile to use Spotify so it would be very nice to choose it to be implemented as a mobile app too.

➕ Additional Information

As there is no such apps that holds the ability to change the theme of Spotify to another level and those mouth watering features so it would be great to get such an app on mobile. Hope this get view. I'm anticipating a positive response from you.