Skip to content
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

Improve troubleshooting and installation docs a bit #3004

Merged
merged 7 commits into from
Jul 6, 2022

Conversation

michaelpj
Copy link
Collaborator

@michaelpj michaelpj commented Jun 30, 2022

@michaelpj michaelpj requested a review from hasufell June 30, 2022 10:26
@michaelpj michaelpj requested a review from jneira as a code owner June 30, 2022 10:26
@hasufell
Copy link
Member

@mouse07410

docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
@hasufell
Copy link
Member

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.
Copy link
Contributor

@sloorush sloorush Jun 30, 2022

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.

Copy link
Collaborator Author

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...).

Copy link
Collaborator Author

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 🤔

@michaelpj
Copy link
Collaborator Author

Can I get an approve? :)

docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Show resolved Hide resolved
@michaelpj michaelpj added the merge me Label to trigger pull request merge label Jul 6, 2022
@mergify mergify bot merged commit 293704f into haskell:master Jul 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge me Label to trigger pull request merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants