Documentation is out-of-date/incomplete

middaymoon commented

2025-11-28 21:32:01 +00:00

Currently the README for this repo points to https://spotizerr.readthedocs.io/en/latest/user/getting-started/ but that manual still has several links to the dead repo on Github, such as the docker-compose file.

❤️ 1

lonhdoan commented

2025-11-29 02:25:54 +00:00

Yes, the project on lavaforge is just a copy, we should make a new doc for new users.

👍 1

middaymoon commented

2025-11-29 06:15:22 +00:00

Author

Do we need a whole new one? Is there any way to update the existing one?

lonhdoan commented

2025-11-29 12:05:37 +00:00

On readthedocs, I don't think there is any, but we can create a fork and edit the README right on Lavaforge.

spotizerrphoenix commented

2025-11-29 21:41:58 +00:00

Owner

@middaymoon wrote in #2 (comment):

Currently the README for this repo points to https://spotizerr.readthedocs.io/en/latest/user/getting-started/ but that manual still has several links to the dead repo on Github, such as the docker-compose file.

this may be in the works depending on the amount of changes in this version.

for context, this project has just begun and is a slight fork/reincarnation of the original spotizerr repositories to get it back up and running with minimal/required changes

the original docs are still relevant but must be tailored to the new spotizerr-phoenix images/builds/repos/etc.
the plan is to keep the original/legacy docs, stylings, etc as much as possible to pay respects to the original team and will require some refactoring without introducing breaking changes
as mentioned in the origins for this project: spotizerr/spotizerr#19
- we are not a part of the original dev team of spotizerr and do not have access to previous spotizerr repos and docs
- for now, minor things have been updated such as the image used in thedocker-compose.yml, etc
- the intention is to maintain it to keep it working throughout time
there are plans to change a few things so documentation updates will be included as things progress.

thanks to everyone for the patience as things ramp up

(keeping this issue open for reference)

@middaymoon wrote in https://lavaforge.org/spotizerrphoenix/spotizerr-phoenix/issues/2#issue-380: > Currently the README for this repo points to https://spotizerr.readthedocs.io/en/latest/user/getting-started/ but that manual still has several links to the dead repo on Github, such as the docker-compose file. this may be in the works depending on the amount of changes in this version. for context, this project has just begun and is a slight fork/reincarnation of the original spotizerr repositories to get it back up and running with minimal/required changes - the original docs are still relevant but must be tailored to the new spotizerr-phoenix images/builds/repos/etc. - the plan is to keep the original/legacy docs, stylings, etc as much as possible to pay respects to the original team and will require some refactoring without introducing breaking changes - as mentioned in the origins for this project: https://lavaforge.org/spotizerr/spotizerr/issues/19 - we are not a part of the original dev team of spotizerr and do not have access to previous spotizerr repos and docs - for now, minor things have been updated such as the image used in the`docker-compose.yml`, etc - the intention is to maintain it to keep it working throughout time - there are plans to change a few things so documentation updates will be included as things progress. thanks to everyone for the patience as things ramp up (keeping this issue open for reference)

👍 3

Krunox commented

2025-11-30 09:01:15 +00:00

I've skimmed through the original project documentation, and it remains relevant.

Only the Getting Started document needs updating, as it points to a non-existent GitHub repository and an outdated Docker image.

I've skimmed through the original project documentation, and it remains relevant. Only the Getting Started document needs updating, as it points to a non-existent GitHub repository and an outdated Docker image.

👍 1 ❤️ 1

spotizerrphoenix commented

2025-12-02 00:47:38 +00:00

Owner

@middaymoon @lonhdoan @Krunox

new docs url: https://spotizerr-phoenix.readthedocs.io

updated previous repo/links/wording

closing this issue for now, check it out, and reopen if you see any changes needed

@middaymoon @lonhdoan @Krunox new docs url: https://spotizerr-phoenix.readthedocs.io - updated previous repo/links/wording closing this issue for now, check it out, and reopen if you see any changes needed

❤️ 2

spotizerrphoenix closed this issue

2025-12-02 00:47:38 +00:00

Rows
Columns

Documentation is out-of-date/incomplete #2