Use index.md for introduction to YAML configuration

Author: mpilgrem

doc/commands/build_command.md

@@ -937,7 +937,7 @@ All the following examples assume that:
     consequently, the project-level configuration will be determined by a
     `stack.yaml` file in the `global-project` directory in the
     [Stack root](../topics/stack_root.md) (for further information, see the
-    [configuration](../configure/yaml/yaml_configuration.md) documentation); and
+    [configuration](../configure/yaml/index.md) documentation); and
 
 *   if `stack build` is commanded in a project directory, there is a
     `stack.yaml` file in that directory.

doc/configure/environment_variables.md

@@ -88,15 +88,15 @@ sequences for color to its output.
 ## `STACK_CONFIG`
 
 Related command: all commands that make use of Stack's
-[global configuration](yaml/yaml_configuration.md) files (`config.yaml`).
+[global configuration](yaml/index.md) files (`config.yaml`).
 
 The environment variable `STACK_CONFIG` can be used to specify an absolute path
 to the user-specific global configuration file, overriding the default.
 
 ## `STACK_GLOBAL_CONFIG`
 
 Related command: all commands that make use of Stack's
-[global configuration](yaml/yaml_configuration.md) files (`config.yaml`).
+[global configuration](yaml/index.md) files (`config.yaml`).
 
 The environment variable `STACK_GLOBAL_CONFIG` can be used to specify an
 absolute path to the system-wide global configuration file, overriding the
@@ -105,8 +105,7 @@ default.
 ## `STACK_ROOT`
 
 Related command: all commands that make use of Stack's
-[user-specific global configuration](yaml/yaml_configuration.md) file
-(`config.yaml`).
+[user-specific global configuration](yaml/index.md) file (`config.yaml`).
 
 Overridden by: Stack's global
 [`--stack-root`](global_flags.md#-stack-root-option) option.
@@ -131,8 +130,7 @@ the root directory of the project or package. The relative path cannot include a
 ## `STACK_XDG`
 
 Related command: all commands that make use of Stack's
-[user-specific global configuration](yaml/yaml_configuration.md) file
-(`config.yaml`).
+[user-specific global configuration](yaml/index.md) file (`config.yaml`).
 
 Overridden by: the use of Stack's `STACK_ROOT` environment variable, or the use
 of Stack's global
@@ -145,7 +143,7 @@ set to any non-empty value.
 ## `STACK_YAML`
 
 Related command: all commands that make use of Stack's
-[project-level configuration](yaml/yaml_configuration.md).
+[project-level configuration](yaml/index.md).
 
 Overridden by: Stack's global
 [`--stack-yaml`](global_flags.md#-stack-yaml-option) option.

doc/configure/index.md

@@ -26,7 +26,7 @@ Stack is configured by the content of files in the YAML formal. A global
 configuration file contains non-project specific options. A project-level
 configuration file contains project-specific options and may contain non-project
 specific options. For further information, see the
-[configuration](yaml/yaml_configuration.md) documentation.
+[configuration](yaml/index.md) documentation.
 
 ## Global flags and options
 

doc/configure/yaml/yaml_configuration.md renamed to doc/configure/yaml/index.md

@@ -1,6 +1,9 @@
+---
+title: Configuration files
+---
 <div class="hidden-warning"><a href="https://docs.haskellstack.org/"><img src="https://cdn.jsdelivr.net/gh/commercialhaskell/stack/doc/img/hidden-warning.svg"></a></div>
 
-# Configuration
+# Configuration files
 
 Stack is configured by the content of files in the [YAML](https://yaml.org/)
 format.

doc/faq.md

@@ -96,8 +96,8 @@
     project-level configuration file. This may be the file in the
     `global-project` directory in the [Stack root](topics/stack_root.md).
 
-    For further information, see the
-    [configuration](configure/yaml/yaml_configuration.md) documentation.
+    For further information, see the [configuration](configure/yaml/index.md)
+    documentation.
 
 ??? question "How does Stack determine what GHC to use?"
 
@@ -282,14 +282,13 @@
 
     Add the package version to the [`extra-deps`](configure/yaml/project.md)
     project-specific configuration option in the
-    [project-level configuration file](configure/yaml/yaml_configuration.md).
+    [project-level configuration file](configure/yaml/index.md).
 
 ??? question "How do I use a package version not on Hackage?"
 
     Add the location of the package version to the
     [`extra-deps`](configure/yaml/project.md) project-specific configuration
-    option in the
-    [project-level configuration file](configure/yaml/yaml_configuration.md).
+    option in the [project-level configuration file](configure/yaml/index.md).
 
     For further information, see the
     [package location](topics/package_location.md) documentation.
@@ -300,7 +299,7 @@
     Add the location of the package to the
     [`packages`](configure/yaml/project.md#packages) project-specific
     configuration option in the
-    [project-level configuration file](configure/yaml/yaml_configuration.md).
+    [project-level configuration file](configure/yaml/index.md).
 
     One way to get the source code for the unmodified package version is to use
     the [`stack unpack`](commands/unpack_command.md).

doc/install_and_upgrade.md

@@ -75,8 +75,8 @@ To get and use Stack, some other things need to be in place first:
 
     [^1]:
         About 3 GB for a single version of GHC and about 2 GB for a local copy
-        of the Hackage package index. 
- 
+        of the Hackage package index.
+
     *[platform]: Machine architecture (eg x86_64, AArch64) and operating system (eg Linux distribution, macOS, Windows).
 
 -   :material-wifi:{ .lg .middle } __Access to the Internet__
@@ -690,8 +690,7 @@ Stack can be installed directly or by using the GHCup tool.
     After installation, Stack will need to be configured before it can download
     large files consistently from within China (without reliance on a VPN).
     Please add the following to the bottom of the
-    [global configuration file](configure/yaml/yaml_configuration.md)
-    (`config.yaml`):
+    [global configuration file](configure/yaml/index.md) (`config.yaml`):
 
     ~~~yaml
     ###ADD THIS IF YOU LIVE IN CHINA

mkdocs.yml

@@ -88,8 +88,8 @@ nav:
 - Configure:
   - configure/index.md
   - Environment variables: configure/environment_variables.md
-  - Configuration:
-    - Introduction: configure/yaml/yaml_configuration.md
+  - Configuration files:
+    - configure/yaml/index.md
     - Project-specific: configure/yaml/project.md
     - Non-project specific: configure/yaml/non-project.md
   - Global flags and options: configure/global_flags.md

stack.cabal

@@ -1,6 +1,6 @@
 cabal-version: 2.0
 
--- This file has been generated from package.yaml by hpack version 0.36.0.
+-- This file has been generated from package.yaml by hpack version 0.37.0.
 --
 -- see: https://github.com/sol/hpack
 
@@ -76,9 +76,9 @@ extra-source-files:
     doc/configure/environment_variables.md
     doc/configure/global_flags.md
     doc/configure/index.md
+    doc/configure/yaml/index.md
     doc/configure/yaml/non-project.md
     doc/configure/yaml/project.md
-    doc/configure/yaml/yaml_configuration.md
     doc/CONTRIBUTING.md
     doc/dev_containers.md
     doc/faq.md