update links, fix typos, style improvements

Author: takase1121

docs/about/contributors.md

@@ -6,7 +6,7 @@ description: A list of people that contributed to Lite XL.
 
 This is a list of people with more than 2 commits to Lite XL.
 The actual number of contributors is far, far greater than what we're able to
-list here, including plugins, themes, LPM and bug hunters and beta testers.
+list here, including plugins, themes, lpm, bug hunters and beta testers.
 We deeply appreciate the effort you have put into making Lite XL better.
 
 You can get the contributors for a particular release on the [release page].

docs/about/faq.md

@@ -73,35 +73,32 @@ keymap.add({ ["ctrl+escape"] = {} }, true)
 
 You can search for commands in the command palette.
 
-For each command, replace the spaces on the right side with dashes.
+For each command, replace the spaces with dashes.
 
 For example: `Core: Find Command` → `core:find-command`
 
 ## What version of Lua does Lite XL use?
 
-Lua 5.4 since v2.1.0 and Lua 5.4.2 before v2.1.0.
-There's some activity around using LuaJIT instead (which is 5.1)
-but it can provide some Lua 5.2 compatibility.
-[Ongoing work][master-luajit-branch] is being done to
-maintain compatibility between LuaJIT and Lua 5.4,
-but this is not officially supported.
+Lua 5.4, since [v2.1.0], released in late 2022.
+
+Lite XL used Lua 5.2 before [v2.1.0].
 
 ## Vim mode?
 
 You need to [vibe].
 
 
-[lite]:                 https://github.com/rxi/lite
-[rxi]:                  https://github.com/rxi/lite
-[FreeType]:             https://freetype.org/
-[AGG]:                  https://agg.sourceforge.net/antigrain.com/index.html
-[rejected]:             https://github.com/rxi/lite/issues/145#issuecomment-643636679
-[plugin repository]:    https://github.com/lite-xl/lite-xl-plugins
-[LPM]:                  https://github.com/lite-xl/lite-xl-plugin-manager
-[here]:                 ../user-guide/managing-plugins.md
-[v2.1.0]:               https://github.com/lite-xl/lite-xl/releases/tag/v2.1.0
-[LSP]:                  https://github.com/lite-xl/lite-xl-lsp
-[lite-xl-terminal]:     https://github.com/adamharrison/lite-xl-terminal
-[autowrap]:             https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/autowrap.lua?raw=1
-[master-luajit-branch]: https://github.com/lite-xl/lite-xl/pull/880
-[vibe]:                 https://github.com/eugenpt/lite-xl-vibe
+[lite]:              https://github.com/rxi/lite
+[rxi]:               https://github.com/rxi/lite
+[FreeType]:          https://freetype.org/
+[AGG]:               https://agg.sourceforge.net/antigrain.com/index.html
+[rejected]:          https://github.com/rxi/lite/issues/145#issuecomment-643636679
+[plugin repository]: https://github.com/lite-xl/lite-xl-plugins
+[LPM]:               https://github.com/lite-xl/lite-xl-plugin-manager
+[here]:              ../user-guide/managing-plugins.md
+[v2.1.0]:            https://github.com/lite-xl/lite-xl/releases/tag/v2.1.0
+[LSP]:               https://github.com/lite-xl/lite-xl-lsp
+[lite-xl-terminal]:  https://github.com/adamharrison/lite-xl-terminal
+[autowrap]:          https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/autowrap.lua?raw=1
+[Pragtical]:         https://pragtical.dev
+[vibe]:              https://github.com/eugenpt/lite-xl-vibe

docs/user-guide/lsp.md

@@ -19,7 +19,7 @@ When installing the plugin manually, you must also install these plugins as well
 
 === "lpm"
 
-    To install LPM via the command line, run:
+    To install a plugin with lpm via the command line, run:
     ```sh
     $ lpm plugin install lsp
     ```
@@ -278,4 +278,4 @@ without Python at all.
 [jdt.ls]:                     https://github.com/eclipse-jdtls/eclipse.jdt.ls
 [win-execution-alias]:        ../assets/user-guide/win-execution-alias.png
 [Python]:                     https://www.python.org/
-[jdtls-cmdline]:              https://github.com/eclipse-jdtls/eclipse.jdt.ls?tab=readme-ov-file#running-from-the-command-line
+[jdtls-cmdline]:              https://github.com/eclipse-jdtls/eclipse.jdt.ls?tab=readme-ov-file#running-from-the-command-line

docs/user-guide/managing-plugins.md

@@ -9,11 +9,11 @@ All plugins can be found at the [plugin repository][lite-xl/lite-xl-plugins].
 
 !!! note
     These plugins are contributed by the community.
-    Support are provided on a voluntary basis.
+    Support is provided on a voluntary basis.
 
 ## Location
 
-Plugins that come bundled with Lite XL is usually stored in `DATADIR/plugins`.
+Plugins that come bundled with Lite XL are stored in `DATADIR/plugins`.
 `DATADIR` is the directory where Lite XL's Lua code is stored.
 
 On macOS, `DATADIR` is always the application resources directory.
@@ -25,30 +25,19 @@ Otherwise, Lite XL sets `DATADIR` as `(path to lite-xl.exe)/data`.
 User plugins should be installed into `USERDIR/plugins`.
 `USERDIR` is the directory where user configuration is stored.
 
-## Plugin managers
+## Plugin Managers
 
-Recently, we've standardized various aspects of the plugin repository to allow for plugins manager
-such as [lpm] and [Miq] to install and manage plugins.
-
-lpm is a plugin manager more akin to distro package managers such as `apt` and `dnf`.
-It also provides a GUI for installing plugins.
-Miq is a declarative plugin manager that allows user to declare plugins
-and install/update them all at once.
+[lpm] is the de-facto plugin manager for Lite XL.
+It is similar to `apt` and `dnf` which provides a command-line interface to manage plugins.
+[Miq] is an alternative declarative plugin manager that allow users to declare a list of plugins
+that should be loaded, and install / updates them all at once.
+Both plugin managers operate on [manifest files] which contains plugin metadata and install instructions.
 
 These two plugin managers use vastly different ways of plugin management, 
-so please consult the main page for each plugin manager for exact instructions.
+so please consult the documentation for each plugin manager for exact instructions.
 
 ## Installing plugins
 
-To install a plugin, simply drag the related plugin file into `USERDIR/plugins`.
-
-??? warning "For plugins that comes in a folder, please consult documentation from the plugins."
-    Historically, Lite XL does not enforce a specific file structure
-    for these types of plugins.
-    Old plugins may not have a `init.lua` file, which is used by
-    Lua to find a plugin.
-    In this case, you need to follow their install instructions.
-
 === "lpm"
 
     To install a plugin with lpm, use `lpm plugin install`.
@@ -81,12 +70,23 @@ To install a plugin, simply drag the related plugin file into `USERDIR/plugins`.
 
     Afterwards, you can run the command `miq:install` to install the plugins.
 
-## Updating plugins
+=== "Manually"
+
+    To install a plugin manually without using plugin managers such as lpm or Miq,
+    you need to locate the `USERDIR` directory in your system.
+    This directory is usually located in the following locations:
+    
+    - Linux / Unix-based systems: `~/.config/lite-xl`
+    - Winodws: `C:/Users/<username>/.config/lite-xl`
+    - macOS: `/Users/<username>/.config/lite-xl`
+
+    Open `USERDIR` in a file manager / shell of your preference and navigate to the `plugins` folder.
+    Copy the plugin file / directory into the `plugins` folder, and restart Lite XL.
 
-To update a plugin, you'll need to re-download them.
-For plugins hosted as separate git repositories, you can simply pull new updates.
+    **Different plugins may have different installation instructions.**
+    **You must consult the installation instructions for each plugin.**
 
-If you have a plugin manager installed, updating plugins should be easier.
+## Updating plugins
 
 === "lpm"
 
@@ -100,11 +100,15 @@ If you have a plugin manager installed, updating plugins should be easier.
 
 === "Miq"
 
-    To update plugins with Miq, run "miq:update".
+    To update plugins with Miq, run `miq:update` in Lite XL.
 
-## Uninstalling plugins
+=== "Manually"
+
+    To update a plugin manually, you can download the latest version
+    and replace the files in the `USERDIR/plugins`.
+    **Do not update plugins installed by lpm or Miq manually.**
 
-To remove a plugin, simply delete the associated file/directory.
+## Uninstalling plugins
 
 === "lpm"
 
@@ -122,6 +126,11 @@ To remove a plugin, simply delete the associated file/directory.
 
     **Uninstalling plugins in Miq is currently not supported.**
 
+=== "Manually"
+
+    To uninstall a plugin manually, simply delete the corresponding file / directory
+    from `USERDIR/plugins`. **Do not uninstall plugins managed by lpm manually**.
+
 ## Recommended plugins
 
 Here are a list of plugins that most users would want:
@@ -141,8 +150,10 @@ Here are a list of plugins that most users would want:
 | [lsp]                | Language Server support for Lite XL
 | [lspkind]            | Completion menu kind/type icons for Lite XL LSP
 | [minimap]            | Minimap
+| [search_ui]          | Provides a better UI for searching text, based on [widget].
 | [selectionhighlight] | Highlight code that matches the selection
 | [settings]           | Settings GUI for Lite XL (requires the [widget] plugin)
+| [terminal]           | Integrated terminal in Lite XL.
 | [widgets]            | Widget toolkit for Lite XL. Needed for [lsp] and [settings].
 
 ## Feature / Plugin Requests
@@ -151,7 +162,7 @@ If no plugins provide the features you wanted, you can request them in the [issu
 Plugin developers occasionally browse the issue tracker for requests and implement them.
 
 Alternatively, you can take the opportunity to implement the feature yourself,
-based on various [documentation] and existing plugins.
+based on our [documentation] and existing plugins.
 
 
 [treeview]:                https://github.com/lite-xl/lite-xl/blob/master/data/plugins/treeview.lua
@@ -160,6 +171,7 @@ based on various [documentation] and existing plugins.
 [lite-xl/lite-xl-plugins]: https://github.com/lite-xl/lite-xl-plugins
 [lpm]:                     https://github.com/lite-xl/lite-xl-plugin-manager
 [Miq]:                     https://github.com/TorchedSammy/Miq
+[manifest files]:          https://github.com/lite-xl/lite-xl-plugin-manager/blob/master/SPEC.md
 [align_carets]:            https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/align_carets.lua?raw=1
 [autoinsert]:              https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/autoinsert.lua?raw=1
 [autosave]:                https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/autosave.lua?raw=1
@@ -173,8 +185,10 @@ based on various [documentation] and existing plugins.
 [lsp]:                     https://github.com/lite-xl/lite-xl-lsp
 [lspkind]:                 https://github.com/TorchedSammy/lite-xl-lspkind
 [minimap]:                 https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/minimap.lua?raw=1
+[search_ui]:               https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/search_ui.lua?raw=1
 [selectionhighlight]:      https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/selectionhighlight.lua?raw=1
 [settings]:                https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/settings.lua?raw=1
+[terminal]:                https://github.com/adamharrison/lite-xl-terminal.git
 [widgets]:                 https://github.com/lite-xl/lite-xl-widgets
 [issue tracker]:           https://github.com/lite-xl/lite-xl-plugins/issues
 [documentation]:           ../developer-guide/introduction.md