self-hosted icon indicating copy to clipboard operation
self-hosted copied to clipboard

docs: Update "more options here" link in README

Open jprenken opened this issue 10 months ago • 4 comments

The "more options here" link pointed to an old Revolt.toml commit showing options which have since changed. Point to the main branch instead.

Please make sure to check the following tasks before opening and submitting a PR

  • [x] I understand and have followed the contribution guide
  • [x] I have tested my changes locally and they are working as intended

jprenken avatar Mar 08 '25 04:03 jprenken

Hmm, I'm not sure about pointing to main, since that's usually ahead of what's live on self-hosted and may lead to confusion about added/renamed config keys. Manually updating the link every time an update is released is also far too tedious, so this needs a bit of pondering to figure out the best solution.

IAmTomahawkx avatar Mar 08 '25 19:03 IAmTomahawkx

Does GitHub maybe provide a way to point to the latest tagged release? That's usually a safe bet.

insertish avatar Apr 25 '25 10:04 insertish

It seems to only support tags, branches, and commit SHA. Don't think it's worth automating unless if someone is interested.

Typically once something reaches main it is tagged relatively quickly for use (in theory) so maybe it's not an issue to just put main?

insertish avatar Apr 25 '25 10:04 insertish

I think that is totally fine to put main. Can always come back later put a note somewhere on here (self-hosted's readme) that the compose.yml is using tested versions rather than just running the bleeding edge. But likely can just leave that off.

Docteh avatar May 13 '25 17:05 Docteh

Closing in favour of using stable branch

insertish avatar Jul 18 '25 10:07 insertish