-
-
Notifications
You must be signed in to change notification settings - Fork 390
Improve troubleshooting and installation docs a bit #3004
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
If optparse-applicative was able to generate manpages, we could just upload a ghcup manpage: pcapriotti/optparse-applicative#176 |
and `stack install --stack-yaml stack-<GHCVER>.yaml`, is not recommended for most people. | ||
Said command builds the `haskell-language-server` binary and installs it in the default Cabal binaries folder, | ||
Said command builds the `haskell-language-server` binary and installs it in the default `cabal` binaries folder, | ||
but the binary will only work with projects that use the same GHC version that built it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we somehow highlight this line a little?
I personally had missed this while skimming through the docs and realized it later on. I think adding it as a note maybe can highlight the point.
Edit: This as in:
the binary will only work with projects that use the same GHC version that built it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this section shouldn't be emphasized anyway and there is a section about this on the troubleshooting page already (which hopefully people actually read...).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally there is a lot of stuff in the installation doc, and I wonder if it could be organized better 🤔
Can I get an approve? :) |
ghcup compile
cabal update
toghcup compile
instructions in troubleshooting.md #2799 and Troubleshooting: Add solution from #1882 #2795