doc: dedicate page for settings

Author: srid

doc/dependency.md

@@ -71,48 +71,11 @@ haskellProjects.default = {
 
 ## Overriding a Haskell package settings {#settings}
 
-```nix
-haskellProjects.default = {
-  settings = {
-    ema = {  # This module can take `{self, super, ...}` args, optionally.
-      # Disable running tests
-      check = false;
-
-      # Disable building haddock (documentation)
-      haddock = false;
-
-      # Ignore Cabal version constraints
-      jailbreak = true;
+See [[settings]]
 
-      # Extra non-Haskell dependencies
-      extraBuildDepends = [ pkgs.stork ];
-
-      # Source patches
-      patches = [ ./patches/ema-bug-fix.patch ];
-
-      # Enable/disable Cabal flags
-      cabalFlags.with-generics = true;
-
-      # Allow building a package marked as "broken"
-      broken = false;
-    };
-  };
-};
-```
-
->[!info] Note
-> ### [nixpkgs] functions
-> 
-> - The `pkgs.haskell.lib` module provides various utility functions that you can use to override Haskell packages. The canonical place to find documentation on these is [the source](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/haskell-modules/lib/compose.nix). haskell-flake provides a `settings` submodule for convienience. For eg., the `dontCheck` function translates to `settings.<name>.check`; the full list of options can be seen [here](https://github.com/srid/haskell-flake/blob/master/nix/modules/project/settings/all.nix).
-
-## Sharing settings {#settings-share}
+## Sharing dependency overrides {#share}
 
 [[modules]] export both `packages` and `settings` options for reuse in downstream Haskell projects.
 
-## Examples
-
-- [Emanote overrides](https://github.com/srid/emanote/commit/5b24bd04f94e03afe66ee01da723e4a05d854953): also demonstrates how to add a *new* setting option (`removeReferencesTo`).
-
-
 
-[nixpkgs]: https://zero-to-nix.com/concepts/nixpkgs
+[nixpkgs]: https://nixos.asia/en/nixpkgs

doc/devshell.md

@@ -1,5 +1,5 @@
 ---
-order: -9
+order: -8
 ---
 
 # DevShell

doc/guide.md

@@ -5,6 +5,7 @@ order: -9
 # Guide
 
 - [[dependency]]#
+- [[settings]]#
 - [[devshell]]#
 - [[package-set]]#
 - [[modules]]#

doc/modules.md

@@ -56,7 +56,7 @@ By default, haskell-flake will generate the following modules for the "default"
 | -- | -- |
 | `haskellFlakeProjectModules.output` | Local packages & dependency overrides |
 
-The idea here being that you can "connect" two Haskell projects such that they depend on one another while reusing the overrides (`packages` and `settings`) from one place. For example, if you have a project "foo" that depends on "bar" and if "foo"'s flake.nix has "bar" as its input, then in "foo"'s `haskellProject.default` entry you can import "bar" as follows:
+The idea here being that you can "connect" two Haskell projects such that they depend on one another while reusing the overrides -- `packages` (see [[dependency]]) and `settings` (see [[settings]]) -- from one place. For example, if you have a project "foo" that depends on "bar" and if "foo"'s flake.nix has "bar" as its input, then in "foo"'s `haskellProject.default` entry you can import "bar" as follows:
 
 ```nix
 # foo's flake.nix's perSystem

doc/settings.md

@@ -0,0 +1,52 @@
+---
+order: -9
+---
+
+# Package Settings
+
+Settings for individual Haskell packages can be specified in the `settings` attribute of a `haskellProjects` module. 
+
+```nix
+haskellProjects.default = {
+  settings = {
+    ema = {  # This module can take `{self, super, ...}` args, optionally.
+      # Disable running tests
+      check = false;
+
+      # Disable building haddock (documentation)
+      haddock = false;
+
+      # Ignore Cabal version constraints
+      jailbreak = true;
+
+      # Extra non-Haskell dependencies
+      extraBuildDepends = [ pkgs.stork ];
+
+      # Source patches
+      patches = [ ./patches/ema-bug-fix.patch ];
+
+      # Enable/disable Cabal flags
+      cabalFlags.with-generics = true;
+
+      # Allow building a package marked as "broken"
+      broken = false;
+    };
+  };
+};
+```
+
+>[!info] Note
+> ### [nixpkgs] functions
+> 
+> - The `pkgs.haskell.lib` module provides various utility functions that you can use to override Haskell packages. The canonical place to find documentation on these is [the source](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/haskell-modules/lib/compose.nix). haskell-flake provides a `settings` submodule for convenience. For eg., the `dontCheck` function translates to `settings.<name>.check`; the full list of options can be seen [here](https://github.com/srid/haskell-flake/blob/master/nix/modules/project/settings/all.nix).
+
+## Sharing package settings {#share}
+
+[[modules]] export both `packages` and `settings` options for reuse in downstream Haskell projects.
+
+## Custom settings {#custom}
+
+- [Emanote overrides](https://github.com/srid/emanote/commit/5b24bd04f94e03afe66ee01da723e4a05d854953): demonstrates how to add a *new* setting option (`removeReferencesTo`).
+
+
+[nixpkgs]: https://nixos.asia/en/nixpkgs