Improve documentation related to Stack hooks #12
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reorganises the existing 'Stack hooks' content to bring forward how to get the hook (using the recommended method). In three relevant places, tells users that the commands to install GHCup and the Haskell Toolchain can safely be run again at any time. Introduces that the commands to install GHCup and the Haskell Toolchain use a `sh` script (true on all platforms). Makes the steps to get the Stack hook manually relevant to all operating systems (not just Unix-like ones). Updates the text for the passage of time: e.g. Stack 2.9.1 is no longer 'new'. Uses language about Stack that is closer to the language that Stack's online documentation uses about itself. Also fixes a closing </p> tag (present as <p>).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation: a discussion on Matrix where it was suggested that some people who get Stack via GHCup are missing the Stack hook when they want to use the hook. This pull request proposes some minor changes to existing GHCup's online documentation to:
emphasise (pull forward) that the recommended way to get the hook is to run the commands that install GHC and the Haskell Toolchain; and
to bring to people's attention that those commands can safely be run again at any time.
More specifically:
Reorganises the existing 'Stack hooks' content to bring forward how to get the hook (using the recommended method).
In three relevant places, tells users that the commands to install GHCup and the Haskell Toolchain can safely be run again at any time.
Introduces that the commands to install GHCup and the Haskell Toolchain use a
shscript (true on all platforms).Makes the steps to get the Stack hook manually relevant to all operating systems (not just Unix-like ones).
Updates the text for the passage of time: e.g. Stack 2.9.1 is no longer 'new'.
Uses language about Stack that is closer to the language that Stack's online documentation uses about itself.
Also fixes a closing </p> tag (present as <p>).
'Tested' by using
mkdocs buildlocally and reading the resulting pages.