Skip to content

Commit

Permalink
Add steps for indexing troubleshooting
Browse files Browse the repository at this point in the history
  • Loading branch information
andyw8 committed Jul 25, 2024
1 parent edfe065 commit b33b366
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,17 @@ 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](README.md#Configuring-code-indexing).

In rare cases, Ruby LSP will encounter an error which prevents parsing from completing, meaning Ruby LSP cannot start.

To diagnose the particular file(s) causing a problem, run `ruby-lsp --doctor`. Please log an issue so that we we can address it. If the code is not open source then you can try write a minimal reproduction.

In the meantime, you can [configure Ruby LSP to ignore a particular gem or file for indexing]([README.md#Configuring-code-indexing]).


## After troubleshooting

If after troubleshooting the Ruby LSP is still not initializing properly, please report an issue
Expand Down

0 comments on commit b33b366

Please sign in to comment.