faq section

julia-vscode · Nov 7, 2021 · 5d8d417 · 5d8d417
1 parent eb9a1f8
commit 5d8d417
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -9,6 +9,7 @@ makedocs(
         "Home" => "index.md",
         # "Setup" => "setup.md",
         "Getting Started" => "gettingstarted.md",
+        "FAQ" => "faq.md",
         "User Guide" => Any[
             "Running Code" => "userguide/runningcode.md",
             "Julia Environments" => "userguide/env.md",

diff --git a/docs/src/faq.md b/docs/src/faq.md
@@ -0,0 +1,14 @@
+# Frequently Asked Questions
+
+### The language server fails to precompile. What can I do about that?
+You've probably been directed here by a pop-up like the following
+![LS precompilation failure](./images/precompile-failure.png)
+
+Click the `Open Logs` button or go to `Output` > `Julia Language Server`. You should see a message like this, among others:
+```
+The Language Server failed to precompile.
+Please make sure you have permissions to write to the LS depot path at
+	/home/pfitzseb/.config/Code/User/globalStorage/julialang.language-julia/lsdepot/v1
+```
+
+Your current account needs to have read/write access to the indicated directory. Also make sure that it isn't on a NFS volume or similar, as that may cause issues.
diff --git a/docs/src/images/precompile-failure.png b/docs/src/images/precompile-failure.png