From 85d4ea6f20ffb77083d9d29692f99f0f03c43f83 Mon Sep 17 00:00:00 2001
From: FloatingGhost <hannah@coffee-and-dreams.uk>
Date: Wed, 7 Dec 2022 11:12:18 +0000
Subject: [PATCH] Add docs for diagnostics

---
 .../administration/CLI_tasks/diagnostics.md   | 30 +++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 docs/docs/administration/CLI_tasks/diagnostics.md

diff --git a/docs/docs/administration/CLI_tasks/diagnostics.md b/docs/docs/administration/CLI_tasks/diagnostics.md
new file mode 100644
index 000000000..25572da8a
--- /dev/null
+++ b/docs/docs/administration/CLI_tasks/diagnostics.md
@@ -0,0 +1,30 @@
+# Diagnostics
+
+A few tasks to help with debugging, troubleshooting, and diagnosing problems.
+
+They mostly relate to common postgres queries. 
+
+## Home timeline query plan
+
+This task will print a query plan for the home timeline of a given user.
+
+=== "OTP"
+
+    `./bin/pleroma_ctl diagnostics home_timeline <nickname>`
+
+=== "From Source"
+
+    `mix pleroma.diagnostics home_timeline <nickname>`
+
+## User timeline query plan
+
+This task will print a query plan for the user timeline of a given user,
+from the perspective of another given user.
+
+=== "OTP"
+
+    `./bin/pleroma_ctl diagnostics user_timeline <nickname> <viewing_nickname>`
+
+=== "From Source"
+    
+    `mix pleroma.diagnostics user_timeline <nickname> <viewing_nickname>`
\ No newline at end of file