From 78a39b0eb946a2682f27d29128138a3be6558b23 Mon Sep 17 00:00:00 2001 From: Vince Reuter Date: Tue, 25 Nov 2025 18:25:51 +0100 Subject: [PATCH] combine redundant sections of contributing doc, regarding docs build and Hoogle; close #1777 --- CONTRIBUTING.md | 40 ++++++++++++++-------------------------- 1 file changed, 14 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6331a1572b..7aa01d10ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -148,8 +148,19 @@ from a binary, and then build the haddocks for the project. Often times, it is useful to have a [`hoogle`](https://github.com/ndmitchell/hoogle) server at hand, with the -packages and its dependencies. Our suggestion is to install -[`cabal-hoogle`](https://github.com/kokobd/cabal-hoogle) from github: +packages and its dependencies. + +Our suggestion is to use +[`cabal-hoogle`](https://github.com/kokobd/cabal-hoogle), which is included in +the `nix` shell: + +```bash +nix develop +$ cabal-hoogle generate +$ cabal-hoogle run -- server --local +``` + +If you're not using `nix`, you may install `cabal-hoogle` from github: ```bash git clone git@github.com:kokobd/cabal-hoogle @@ -157,7 +168,7 @@ cd cabal-hoogle cabal install exe:cabal-hoogle ``` -and then run `cabal-hoogle`: +Regardless, once it's available in your environment, run `cabal-hoogle`: ```bash cabal-hoogle generate @@ -217,29 +228,6 @@ the right version of `fourmolu`. nix develop -c ./scripts/ci/run-fourmolu.sh ``` -# Generating documentation and setting up hoogle - -To generate the documentation, use the documentation script: - -```bash -./scripts/docs/haddocks.sh -``` - -Often times, it is useful to have a -[`hoogle`](https://github.com/ndmitchell/hoogle) server at hand, with the -packages and its dependencies. Our suggestion is to use -[`cabal-hoogle`](https://github.com/kokobd/cabal-hoogle) which is included in -the `nix` shell: - -```bash -nix develop -$ cabal-hoogle generate -$ cabal-hoogle run -- server --local -``` - -This will fire a `hoogle` server at https://localhost:8080/ with the local -packages and their dependencies. - ## Making and reviewing changes If you are working on changing a **substantial** part of Consensus, it is