Skip to content

Commit 5191c85

Browse files
committed
Consistency with user's guide etc
Also aims to fix the two-level TOC for MkDocs.
1 parent ada7c44 commit 5191c85

File tree

5 files changed

+16
-17
lines changed

5 files changed

+16
-17
lines changed

doc/GUIDE_advanced.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ of any `STACK_WORK` environment variable.
6262

6363
## The `stack build` command
6464

65-
The `stack build` command is introduced in the first part of
66-
[Stack's user guide](GUIDE.md#the-stack-build-command). For further information
67-
about the command, see the [build command](build_command.md) documentation.
65+
The `stack build` command is introduced in the first part of Stack's
66+
[user's guide](GUIDE.md#the-stack-build-command). For further information about
67+
the command, see the [build command](build_command.md) documentation.
6868

6969
## The `stack config` commands
7070

doc/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,12 +148,12 @@ To manage your library:
148148
file, in its `extra-deps:` section.
149149

150150
That was a really fast introduction on how to start to code in Haskell using
151-
Stack. If you want to go further, we highly recommend you read the
152-
[Stack User Guide](GUIDE.md).
151+
Stack. If you want to go further, we highly recommend you read Stack's
152+
[user's guide](GUIDE.md).
153153

154154
## Complete guide to Stack
155155

156-
A complete [user guide to Stack](GUIDE.md) is available, covering all of
156+
A complete [user's guide](GUIDE.md) to Stack is available, covering all of
157157
the most common ways to use Stack. Terms used in Stack's documentation are also
158158
explained in the [glossary](glossary.md).
159159

doc/build_command.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ The primary command you use in Stack is `build`. This page describes the `build`
88
command's interface. The goal of the interface is to do the right thing for
99
simple input, and allow a lot of flexibility for more complicated goals.
1010

11-
See the introductory part of
12-
[Stack's user guide](GUIDE.md#the-stack-build-command) for an introduction to
13-
the command.
11+
See the introductory part of Stack's
12+
[user's guide](GUIDE.md#the-stack-build-command) for an introduction to the
13+
command.
1414

1515
## Synonyms
1616

@@ -119,7 +119,7 @@ To get a list of the available targets in your project, use `stack ide targets`.
119119
## Controlling what gets built
120120

121121
Stack will automatically build the necessary dependencies. See the introductory
122-
part of [Stack's user guide](GUIDE.md#the-stack-build-command) for information
122+
part of Stack's [user's guide](GUIDE.md#the-stack-build-command) for information
123123
about how these dependencies get specified.
124124

125125
In addition to specifying targets, you can also control what gets built, or

doc/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ here is to be as helpful and concise as possible.
1010

1111
The version of GHC, as well as which packages can be installed, are specified by
1212
the _resolver_. This may be something like `lts-19.19`, which is from
13-
[Stackage](https://www.stackage.org/). The [user guide](GUIDE.md) discusses the
14-
resolver in more detail.
13+
[Stackage](https://www.stackage.org/). The [user's guide](GUIDE.md) discusses
14+
the resolver in more detail.
1515

1616
The resolver is determined by finding the relevant project-level configuration
1717
file (`stack.yaml`) for the directory you're running the command from. This

mkdocs.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ pages:
1717
- Changelog: ChangeLog.md
1818
- Tool documentation:
1919
- Install/upgrade: install_and_upgrade.md
20-
- User guide (introductory): GUIDE.md
21-
- User guide (advanced): GUIDE_advanced.md
20+
- User's guide (introductory): GUIDE.md
21+
- User's guide (advanced): GUIDE_advanced.md
2222
- FAQ: faq.md
2323
- Configuration (project and global): yaml_configuration.md
2424
- stack.yaml vs a Cabal file: stack_yaml_vs_cabal_package_file.md
@@ -40,9 +40,8 @@ pages:
4040
- Advanced documentation:
4141
- Build overview: build_overview.md
4242
- Project documentation:
43-
- For Contributors:
44-
- Contributors guide: CONTRIBUTING.md
45-
- For Maintainers:
43+
- Contributor's guide: CONTRIBUTING.md
44+
- Maintainer's guide:
4645
- Releases: maintainers/releases.md
4746
- Maintainer team process: maintainers/team_process.md
4847
- Add GHC version: maintainers/ghc.md

0 commit comments

Comments
 (0)