Add index troubleshooting steps

Shopify · Sep 30, 2024 · cb3f4e6 · cb3f4e6
1 parent 3153522
commit cb3f4e6
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/jekyll/troubleshooting.markdown b/jekyll/troubleshooting.markdown
@@ -230,6 +230,18 @@ ruby-lsp
 Is there any extra information given from booting the server manually? Or does it only fail when booting through the
 extension?
 
+## Indexing
+
+When Ruby LSP starts, it attempts to index your code as well as your dependencies as described in [Configuring code indexing](index.html#configuring-code-indexing).
+
+In rare cases, Ruby LSP will encounter an error which prevents indexing from completing, which will result in incomplete information in the editor.
+
+Firstly, ensure that you are using the latest release of the `ruby-lsp` gem, as the problem may have been already fixed.
+
+To diagnose the particular file(s) causing a problem, run `ruby-lsp-check`. Please log an issue so that we can address it. If the code is not open source then please provide a minimal reproduction.
+
+In the meantime, you can [configure Ruby LSP to ignore a particular gem or file for indexing](index.html#configuring-code-indexing).
+
 ## After troubleshooting
 
 If after troubleshooting the Ruby LSP is still not initializing properly, please report an issue