From aff99d24bed4dcaeb244d84720fb48283592e142 Mon Sep 17 00:00:00 2001
From: zkldi <ktchidev@gmail.com>
Date: Fri, 17 Sep 2021 13:01:37 +0100
Subject: [PATCH] Add indexing notes

---
 docs/docs/codebase/setup/setup.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/docs/codebase/setup/setup.md b/docs/docs/codebase/setup/setup.md
index 71c369e9d..28ab0c99f 100644
--- a/docs/docs/codebase/setup/setup.md
+++ b/docs/docs/codebase/setup/setup.md
@@ -81,3 +81,19 @@ pnpm start
 This will build the server TypeScript into JS under `/js`,
 and run it. The port it runs on is determined by the config
 file.
+
+### 8. Other Stuff
+
+You will also want to install [ts-node](https://github.com/TypeStrong/ts-node).
+```
+[*sudo] pnpm install -g ts-node
+```
+
+!!! warning
+	You should hopefully need `sudo` to install global binaries with `-g`.
+
+You can then use `ts-node` to run certain scripts in the `scripts/` directory. One of the important
+setup scripts is `scripts/set-indexes.ts`, which will enable indexing (A huge performance increase).
+
+!!! warning
+	Search functionality will crash if indexes are not enabled.