Auto generate docs

Author: github-actions[bot]

doc/lazy-nix-helper.nvim.txt

@@ -1,4 +1,4 @@
-*lazy-nix-helper.nvim.txt*  For Neovim >= 0.8.0? Last change: 2023 December 03
+*lazy-nix-helper.nvim.txt*  For Neovim >= 0.8.0? Last change: 2023 December 04
 
 ==============================================================================
 Table of Contents                     *lazy-nix-helper.nvim-table-of-contents*
@@ -17,15 +17,17 @@ Table of Contents                     *lazy-nix-helper.nvim-table-of-contents*
 1. Lazy-Nix-Helper                      *lazy-nix-helper.nvim-lazy-nix-helper*
 
 A neovim plugin allowing a single neovim configuration with the Lazy plugin
-manager to be used on NixOS and other platforms. This plugin provides:
+manager to be used on NixOS and other platforms. This plugin makes the
+following arrangement possible:
 
 - On NixOS:
-    - plugins(/LSP servers/DAPs/linters/formatters?) installed via Nix
+    - plugins (and LSP servers/DAP servers/linters/formatters) installed via Nix
     - configuration of plugins via Lazy
     - lazy loading of plugins via Lazy
 - On other platforms:
     - the same neovim configuration files you use on NixOS
-    - plugins(/LSP servers/DAPs/linters/formatters?) installed via Lazy(/Mason?) as normal
+    - plugins installed via Lazy installed via Lazy as normal
+    - LSP servers/DAP servers/linters/formatters installed via Mason as normal
     - configuration via Lazy as normal
     - lazy loading of plugins via Lazy as normal
 
@@ -226,8 +228,44 @@ will also require ".nvim" to be appended to the plugin name.
 
 MASON ~
 
-TODO: figure out how to play nicely with Mason included in the configuration
-and add instructions here.
+Mason is a package manager for LSP servers, DAP servers, linters, and
+formatters. Just like plugin management with Lazy, this conflicts with Nix. The
+easiest way to keep mason in your config on non-Nix platforms while disabling
+it on NixOS is to use the provided `mason_enabled` function to conditionally
+enable Mason.
+
+This will require you to separately declare all your LSP servers etc. in your
+NixOS config, but you were doing that already, right?
+
+Here’s an example mason configuration as a dependency of `nvim-lspconfig`.
+Notice that we are using `mason_enabled` to conditionally enable both `mason`
+and `mason-lspconfig
+
+>lua
+    {
+      "neovim/nvim-lspconfig",
+      dir = require("lazy-nix-helper").get_plugin_path("nvim-lspconfig"),
+      dependencies = {
+        {
+          "williamboman/mason.nvim",
+          dir = require("lazy-nix-helper").get_plugin_path("mason.nvim"),
+          enable = require("lazy-nix-helper").mason_enabled(),
+          ...
+        },
+        {
+          "williamboman/mason-lspconfig.nvim",
+          dir = require("lazy-nix-helper").get_plugin_path("mason-lspconfig.nvim"),
+          enable = require("lazy-nix-helper").mason_enabled(),
+          ...
+        },
+        ...
+      },
+      ...
+    }
+<
+
+TODO: do we have to load these things by hand now or is it sufficient to have
+them installed on the system?
 
 
 KNOWN LIMITATIONS     *lazy-nix-helper.nvim-lazy-nix-helper-known-limitations*
@@ -260,6 +298,15 @@ HOW DO I CHECK ALL OF THE PLUGINS THAT LAZY-NIX-HELPER HAS FOUND? ~
 Run the `list_discovered_plugins` function manually: `lua
 require("lazy-nix-helper").list_discovered_plugins()`
 
+
+I DON’T THINK LAZY-NIX-HELPER IS CORRECTLY DETECTING WHEN I’M ON NIXOS ~
+
+Run the `print_environment_info` function manually to see: - if Lazy-Nix-Helper
+thinks you’re on NixOS or not - if Lazy-Nix-Helper thinks nix-store is
+installed or not
+
+`lua require("lazy-nix-helper").print_environment_info()`
+
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
 
 vim:tw=78:ts=8:noet:ft=help:norl: