From c47337f3dbe9289df11fa4b20ce1b2d825cb2aa8 Mon Sep 17 00:00:00 2001
From: strawberry <strawberry@puppygock.gay>
Date: Sun, 8 Sep 2024 10:24:38 -0400
Subject: [PATCH] docs: ignore development.md and contributing.md from lychee

and update 2 other nix references

Signed-off-by: strawberry <strawberry@puppygock.gay>
Signed-off-by: morguldir <morguldir@protonmail.com>
---
 docs/deploying/generic.md   | 2 +-
 docs/development/testing.md | 5 ++---
 engage.toml                 | 2 +-
 nix/pkgs/book/default.nix   | 2 ++
 4 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/docs/deploying/generic.md b/docs/deploying/generic.md
index f0391fec..cae57986 100644
--- a/docs/deploying/generic.md
+++ b/docs/deploying/generic.md
@@ -18,7 +18,7 @@ These binaries have jemalloc and io_uring statically linked and included with
 them.
 
 Alternatively, you may compile the binary yourself. We recommend using
-[Lix](https://lix.systems) to build conduwuit as this has the most guaranteed
+Nix (or [Lix](https://lix.systems) to build conduwuit as this has the most guaranteed
 reproducibiltiy and easiest to get a build environment and output going.
 
 Otherwise, follow standard Rust project build guides (installing git and cloning
diff --git a/docs/development/testing.md b/docs/development/testing.md
index 00f8e258..06720dd8 100644
--- a/docs/development/testing.md
+++ b/docs/development/testing.md
@@ -5,8 +5,8 @@
 Have a look at [Complement's repository][complement] for an explanation of what
 it is.
 
-To test against Complement, with [Lix][lix] and direnv installed and set up, you
-can:
+To test against Complement, with Nix (or [Lix](https://lix.systems) and direnv installed
+and set up, you can:
 
 * Run `./bin/complement "$COMPLEMENT_SRC" ./path/to/logs.jsonl
 ./path/to/results.jsonl` to build a Complement image, run the tests, and output
@@ -18,6 +18,5 @@ Complement OCI image outputted to `result` (it's a `.tar.gz` file)
 output from the commit/revision you want to test (e.g. from main)
 [here][ci-workflows]
 
-[lix]: https://lix.systems/
 [ci-workflows]: https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml?query=event%3Apush+is%3Asuccess+actor%3Agirlbossceo
 [complement]: https://github.com/matrix-org/complement
diff --git a/engage.toml b/engage.toml
index e2428aea..633cb95d 100644
--- a/engage.toml
+++ b/engage.toml
@@ -152,7 +152,7 @@ cargo clippy \
 [[task]]
 name = "lychee"
 group = "lints"
-script = "lychee --verbose --offline docs *.md --exclude development.md"
+script = "lychee --verbose --offline docs *.md --exclude development.md --exclude contributing.md --exclude testing.md"
 
 [[task]]
 name = "markdownlint"
diff --git a/nix/pkgs/book/default.nix b/nix/pkgs/book/default.nix
index cafd162f..3995ab79 100644
--- a/nix/pkgs/book/default.nix
+++ b/nix/pkgs/book/default.nix
@@ -14,8 +14,10 @@ stdenv.mkDerivation {
     include = [
       "book.toml"
       "conduwuit-example.toml"
+      "CODE_OF_CONDUCT.md"
       "CONTRIBUTING.md"
       "README.md"
+      "development.md"
       "debian/conduwuit.service"
       "debian/README.md"
       "arch/conduwuit.service"