Merge branch 'mkdocs-test' into master-merge-mkdocs

Author: mpilgrem

doc/README.md

@@ -143,7 +143,7 @@ Stack can be installed directly or by using the GHCup tool.
             !!! info
 
                 By default, the Windows installer will set the
-                [Stack root](stack_root.md) to `C:\sr`.
+                [Stack root](topics/stack_root.md) to `C:\sr`.
 
             !!! note
 
@@ -318,13 +318,13 @@ section.
 
 That was a really fast introduction on how to start to code in Haskell using
 Stack. If you want to go further, we highly recommend you read Stack's
-introductory [user's guide](GUIDE.md).
+introductory [user's guide](tutorial/index.md).
 
 ## Complete guide to Stack
 
-A complete [user's guide](GUIDE.md) to Stack is available, covering all of
-the most common ways to use Stack. Terms used in Stack's documentation are also
-explained in the [glossary](glossary.md).
+A complete [user's guide](tutorial/index.md) to Stack is available, covering all
+of the most common ways to use Stack. Terms used in Stack's documentation are
+also explained in the [glossary](glossary.md).
 
 ## Why Stack?
 

doc/commands/build_command.md

@@ -29,8 +29,8 @@ stack build [TARGET] [--dry-run] [--pedantic] [--fast] [--ghc-options OPTIONS]
 interface for simple tasks and flexibility for more complicated goals.
 
 See the introductory part of Stack's
-[user's guide](GUIDE.md#the-stack-build-command) for an introduction to the
-command.
+[user's guide](../tutorial/hello_world_example.md#the-stack-build-command) for
+an introduction to the command.
 
 ## Synonyms
 
@@ -206,15 +206,16 @@ its subdirectories.
 ## Controlling what gets built
 
 Stack will automatically build the necessary dependencies. See the introductory
-part of Stack's [user's guide](GUIDE.md#the-stack-build-command) for information
-about how these dependencies get specified.
+part of Stack's
+[user's guide](../tutorial/building_your_project.md#adding-dependencies) for
+information about how these dependencies get specified.
 
 In addition to specifying targets, you can also control what gets built, or
 retained, with the flags and options listed below. You can also affect what gets
 built by specifying Cabal (the library) options for the configure step
 of the Cabal build process (for further information, see the documentation for
-the [configure-options](yaml_configuration.md#configure-options) configuration
-option).
+the [configure-options](../configure/yaml/non-project.md#configure-options)
+configuration option).
 
 ### `--[no-]allow-newer` flag
 
@@ -298,7 +299,7 @@ This overrides:
 !!! note
 
     In order to set a Cabal flag for a GHC boot package, the package must be
-    specified as an [extra-dep](yaml_configuration.md#extra-deps).
+    specified as an [extra-dep](../configure/yaml/project.md#extra-deps).
 
 ### `--[no-]force-dirty` flag
 
@@ -736,20 +737,22 @@ The effect of `--fast` can be overriden with Stack's
     Cabal's default behaviour). The exception is if Cabal's
     `--disable-optimization` flag or `--enable-optimization[=n]`, `-O[n]`
     options are used during the configure step of the Cabal build process; see
-    Stack's [`configure-options`](yaml_configuration.md#configure-options) YAML
-    configuration option.
+    Stack's
+    [`configure-options`](../configure/yaml/non-project.md#configure-options)
+    YAML configuration option.
 
 ### `--ghc-options` option
 
 GHC command line options can be specified for a package in its Cabal file
 (including one created from a `package.yaml` file). This option augments and, if
 applicable (see below), overrides any such GHC command line options and those
 specified in Stack's YAML configuration files - see the
-[`ghc-options`](yaml_configuration.md#ghc-options) configuration option.
+[`ghc-options`](../configure/yaml/non-project.md#ghc-options) configuration
+option.
 
 `stack build --ghc-options <ghc_options>` passes the specified command line
 options to GHC, depending on Stack's
-[`apply-ghc-options`](yaml_configuration.md#apply-ghc-options) YAML
+[`apply-ghc-options`](../configure/yaml/non-project.md#apply-ghc-options) YAML
 configuration option. This option can be specified multiple times.
 
 GHC's command line options are _order-dependent_ and evaluated from left to
@@ -849,14 +852,14 @@ to `happy` its `--ghc` flag.
 By default, all and any `--PROG-option` options on Stack's command line are
 applied to all project packages (targets or otherwise). This behaviour can be
 changed. See the
-[`apply-prog-options`](yaml_configuration.md#apply-prog-options) configuration
-option.
+[`apply-prog-options`](../configure/yaml/non-project.md#apply-prog-options)
+configuration option.
 
 Stack can also be configured to pass Cabal's `--PROG-option`, `--PROG-options`
 or other options to Cabal during the configuration step. For further
 information, see the documentation for the
-[configure-options](yaml_configuration.md#configure-options) configuration
-option.
+[configure-options](../configure/yaml/non-project.md#configure-options)
+configuration option.
 
 ## Flags relating to build outputs
 
@@ -969,9 +972,9 @@ package is targetted in a multi-package project (for example, using
   contents of the log files to the standard error output stream of the console
   at the end of the build, use Stack's `dump-logs` option. For further
   information about that option, see the
-  [YAML configuration](yaml_configuration.md#dump-logs) documentation. The
-  default `dump-logs` mode is to output the contents of any log files that
-  include GHC warnings.
+  [YAML configuration](../configure/yaml/non-project.md#dump-logs)
+  documentation. The default `dump-logs` mode is to output the contents of any
+  log files that include GHC warnings.
 
 ### `--[no]-open` flag
 
@@ -1024,8 +1027,8 @@ All the following examples assume that:
     `stack.yaml` file in the current directory or ancestor directory and,
     consequently, the project-level configuration will be determined by a
     `stack.yaml` file in the `global-project` directory in the
-    [Stack root](stack_root.md) (for further information, see the
-    [YAML configuration](yaml_configuration.md) documentation); and
+    [Stack root](../topics/stack_root.md) (for further information, see the
+    [YAML configuration](../configure/yaml_configuration.md) documentation); and
 
 *   if `stack build` is commanded in a project directory, there is a
     `stack.yaml` file in that directory.

doc/commands/config_command.md

@@ -38,7 +38,7 @@ The command also accepts flags and options of the
 [`stack build`](build_command.md#flags-affecting-ghcs-behaviour) command that
 affect the location of the local project installation directory, such as
 `--profile` and `--no-strip`. For further information, see the documentation of
-the [project Stack work directory](stack_work.md#project-stack-work-directory).
+the [project Stack work directory](../topics/stack_work.md).
 
 ## The `stack config set` commands
 

doc/commands/docker_command.md

@@ -14,8 +14,8 @@ Stack is able to build your code inside a Docker image, which means even more
 reproducibility to your builds, since you and the rest of your team will always
 have the same system libraries.
 
-For further information, see the [Docker integration](docker_integration.md)
-documentation.
+For further information, see the
+[Docker integration](../topics/docker_integration.md) documentation.
 
 ## The `stack docker pull` command
 

doc/commands/exec_command.md

@@ -69,4 +69,4 @@ The command also accepts flags and options of the
 [`stack build`](build_command.md#flags-affecting-ghcs-behaviour) command that
 affect the location of the local project installation directory, such as
 `--profile` and `--no-strip`. For further information, see the documentation of
-the [project Stack work directory](stack_work.md#project-stack-work-directory).
+the [project Stack work directory](../topics/stack_work.md).

doc/commands/index.md

@@ -3,7 +3,7 @@
 # Commands (advanced)
 
 Some of Stack's features will not be needed regularly or by all users. This part
-of the guide and the part on [configuration](configure/index.md) provide
+of the guide and the part on [configuration](../configure/index.md) provide
 information about somethose features, organised as a reference guide. Some of
 the features are complex and separate pages are dedicated to them.
 
@@ -14,8 +14,8 @@ the features are complex and separate pages are dedicated to them.
 * [`setup`](setup_command.md) - get GHC for a Stack project (usually not needed)
 * [`update`](update_command.md) - update the package index (usually not needed)
 * [`new`](new_command.md) - create a new project with Stack
-* [`init`](init_command.md) - initialise Stack's project-level YAML configuration file for an
-  existing project
+* [`init`](init_command.md) - initialise Stack's project-level YAML
+  configuration file for an existing project
 
 ### Building
 
@@ -79,8 +79,8 @@ the features are complex and separate pages are dedicated to them.
 
 * [`hoogle`](hoogle_command.md) - run `hoogle`
 * [`dot`](dot_command.md) - dependency visualization
-* [`hpc`](hpc_command.md) - generate Haskell Program Coverage (HPC) code coverage
-  reports
+* [`hpc`](hpc_command.md) - generate Haskell Program Coverage (HPC) code
+  coverage reports
 
 ### Managing Stack versions
 
@@ -100,14 +100,14 @@ Stack's commands are listed below, in alphabetical order.
 * [`exec`](exec_command.md) - executate a command in the Stack environment
 * [`haddock`](build_command.md) - a synonym for `stack build --haddock`
 * [`hoogle`](hoogle_command.md) - run `hoogle`
-* [`hpc`](hpc_command.md) - generate Haskell Program Coverage (HPC) code coverage
-  reports
+* [`hpc`](hpc_command.md) - generate Haskell Program Coverage (HPC) code
+  coverage reports
 * [`ghc`](ghc_command.md) - run `ghc`
 * [`ghci`](ghci_command.md) - run GHCi, a REPL environment
 * [`ide`](ide_command.md) - information for an integrated development
   environment (IDE)
-* [`init`](init_command.md) - initialise Stack's project-level YAML configuration file for an
-  existing project
+* [`init`](init_command.md) - initialise Stack's project-level YAML
+  configuration file for an existing project
 * [`install`](build_command.md) - a synonym for `stack build --copy-bins`
 * [`list`](list_command.md) - list packages on Hackage or in a snapshot
 * [`ls`](ls_command.md) - list information about Stack

doc/commands/init_command.md

@@ -27,8 +27,8 @@ By default:
 
 If a snapshot is specified at the command line, `stack init` will try to use it.
 For further information, see the documentation for the
-[`--snapshot`](global_flags.md#-snapshot-option) and
-[`--resolver`](global_flags.md#-resolver-option) options.
+[`--snapshot`](../configure/global_flags.md#-snapshot-option) and
+[`--resolver`](../configure/global_flags.md#-resolver-option) options.
 
 Otherwise, `stack init` will try to use the following Stackage snapshots in
 order of preference, using the first that is compatable: the most recent LTS

doc/commands/new_command.md

@@ -19,7 +19,7 @@ By default:
   skip such initialisation; and
 
 * the project template is the one specified by the
-[default-template](yaml_configuration.md#default-template) option.
+[default-template](../configure/yaml/non-project.md#default-template) option.
 
 A package name acceptable to Cabal comprises an alphanumeric 'word'; or two or
 more such words, with the words separated by a hyphen/minus character (`-`). A
@@ -49,8 +49,9 @@ These arguments are ignored if the `--no-init` flag is passed.
 
 If a snapshot is specified at the command line and the project is initialised
 for use with Stack, `stack new` will try to use it. For further information, see
-the documentation for the [`--snapshot`](global_flags.md#-snapshot-option) and
-[`--resolver`](global_flags.md#-resolver-option) options.
+the documentation for the
+[`--snapshot`](../configre/global_flags.md#-snapshot-option) and
+[`--resolver`](../configure/global_flags.md#-resolver-option) options.
 
 ## Project templates
 

doc/commands/path_command.md

@@ -46,4 +46,4 @@ The command also accepts flags and options of the
 [`stack build`](build_command.md#flags-affecting-ghcs-behaviour) command that
 affect the location of the local project installation directory, such as
 `--profile` and `--no-strip`. For further information, see the documentation of
-the [project Stack work directory](stack_work.md#project-stack-work-directory).
+the [project Stack work directory](../topics/stack_work.md).

doc/commands/script_command.md

@@ -21,8 +21,9 @@ Non-project level configuration options in global configuration files
 !!! info
 
     Non-project level configuration options may be useful if
-    [`allow-newer`](yaml_configuration.md#allow-newer) and/or
-    [`allow-newer-deps`](yaml_configuration.md#allow-newer-deps) are required.
+    [`allow-newer`](../configure/yaml/non-project.md#allow-newer) and/or
+    [`allow-newer-deps`](../configure/yaml/non-project.md#allow-newer-deps) are
+    required.
 
 ## Project-level configuration file
 
@@ -39,8 +40,8 @@ Stack root.
 ## GHC
 
 The `stack script` command behaves as if the
-[`--install-ghc`](global_flags.md#--no-install-ghc-flag) flag had been passed at
-the command line.
+[`--install-ghc`](../configure/global_flags.md#--no-install-ghc-flag) flag had
+been passed at the command line.
 
 ## Snapshot and extra-deps
 
@@ -202,7 +203,7 @@ outputs will be written to a directory named `MyScript.hs` at
 
 As for Example 1, but `acme-missiles-0.2` is specified by adding it to the
 snapshot as an extra-dep. The `stack script` command is specified using Stack's
-[script interpreter](scripts.md).
+[script interpreter](../topics/scripts.md).
 
 ~~~haskell
 {- stack script
@@ -243,7 +244,7 @@ Consequently, for example, Stack will:
 Consider also the following script extract, based on snapshot Stackage
  LTS Haskell 20.25, where considerations on Windows differ from non-Windows. The
 `stack script` command is specified using Stack's
-[script interpreter](scripts.md).
+[script interpreter](../topics/scripts.md).
 
 === "Windows"