ruby-lsp icon indicating copy to clipboard operation
ruby-lsp copied to clipboard

Add note about Mise version manager

Open andyw8 opened this issue 1 year ago • 3 comments

See https://github.com/Shopify/ruby-lsp/issues/2170#issuecomment-2162983705

andyw8 avatar Jun 12 '24 14:06 andyw8

I feel like we're starting to replicate documentation that is instead relevant to the version managers themselves. If Mise or ASDF decide to change how they are updated, suddenly our docs are out of date.

What do you think about being more generic and just saying "if you find version manager integration issues, first ensure that you're on the latest version of that version manager" and then delegate to the managers own documentation?

vinistock avatar Jun 12 '24 14:06 vinistock

I've updated it to point to the Mise docs instead. I think the locality of the advice is important - people tend to skim docs, so having this next to the Mise topic makes it more discoverable, rather than as a general statement further up.

andyw8 avatar Jun 12 '24 14:06 andyw8

That's fair. Do you think it's worth adding a section for each version manager pointing to their documentation and recommending keeping it up to date?

vinistock avatar Jun 12 '24 14:06 vinistock