doc(readme): document personal notes

- It's not safe and can corrupt other git repos
- nvim-treesiter maintainers consider `prefer_git` as deprecated and no
  longer needed.

See nvim-treesitter PR for details: https://github.com/nvim-treesitter/nvim-treesitter/pull/6959

README.md

@@ -10,6 +10,28 @@ A starting point for Neovim that is:
 
 **NOT** a Neovim distribution, but instead a starting point for your configuration.
 
+## Renken's notes
+
+### Divergence from upstream
+
+I try to stay as up-to-date as possible with upstream. However certain commits
+that I deliberately skipped cherry-picking because they can be problematic. I
+will try to document all of them below.
+
+* [nvim-lua/kickstart@7513ec8](https://github.com/nvim-lua/kickstart.nvim/commit/7513ec8a7dd579957ce2d9b44e05c1da18d7d0e3)
+deletes `numToStr/Comment.nvim` without justification. Possibly this feature
+was merged in `neovim-v0.10.0`? The changes to use `vim.uv` instead of
+`vim.loop` were not included as a result. I also want to take the time to
+understand what `neodev` and `lazydev` do before integrating the latter. Future
+commits related to it will not be included here either, such as.
+  * [nvim-lua/kickstart@fd66454](https://github.com/nvim-lua/kickstart.nvim/commit/fd66454c4a02abb44568159e7447060b962e1b5d).
+
+* Debian GNU/Linux packages
+[`markdownlint`](https://packages.debian.org/bookworm-backports/markdownlint).
+However, the binary is installed under `/bin/mdl` which breaks
+`lua/kickstart/plugins/lint.lua`. Make sure to execute `ln -s /bin/mdl
+~/.local/bin/markdownlint` or something similar.
+
 ## Installation
 
 ### Install Neovim
@@ -46,8 +68,8 @@ Neovim's configurations are located under the following paths, depending on your
 | OS | PATH |
 | :- | :--- |
 | Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
-| Windows (cmd)| `%userprofile%\AppData\Local\nvim\` |
-| Windows (powershell)| `$env:USERPROFILE\AppData\Local\nvim\` |
+| Windows (cmd)| `%localappdata%\nvim\` |
+| Windows (powershell)| `$env:LOCALAPPDATA\nvim\` |
 
 #### Recommended Step
 
@@ -77,13 +99,13 @@ git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HO
 If you're using `cmd.exe`:
 
 ```
-git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
+git clone https://github.com/nvim-lua/kickstart.nvim.git %localappdata%\nvim\
 ```
 
 If you're using `powershell.exe`
 
 ```
-git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
+git clone https://github.com/nvim-lua/kickstart.nvim.git $env:LOCALAPPDATA\nvim\
 ```
 
 </details>
@@ -226,4 +248,3 @@ sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
 sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
 ```
 </details>
-

init.lua

@@ -126,9 +126,12 @@ vim.opt.spell = true
 vim.opt.showmode = false
 
 -- Sync clipboard between OS and Neovim.
+--  Schedule the setting after `UiEnter` because it can increase startup-time.
 --  Remove this option if you want your OS clipboard to remain independent.
 --  See `:help 'clipboard'`
-vim.opt.clipboard = 'unnamedplus'
+vim.schedule(function()
+  vim.opt.clipboard = 'unnamedplus'
+end)
 
 -- Enable break indent
 vim.opt.breakindent = true
@@ -172,8 +175,8 @@ vim.opt.scrolloff = 10
 -- [[ Basic Keymaps ]]
 --  See `:help vim.keymap.set()`
 
--- Set highlight on search, but clear on pressing <Esc> in normal mode
-vim.opt.hlsearch = true
+-- Clear highlights on search when pressing <Esc> in normal mode
+--  See `:help hlsearch`
 vim.keymap.set('n', '<Esc>', '<cmd>nohlsearch<CR>')
 
 -- Diagnostic keymaps
@@ -503,6 +506,13 @@ require('lazy').setup({
         pin = true,
         opts = {},
       },
+
+      -- Allows extra capabilities provided by nvim-cmp
+      {
+        'hrsh7th/cmp-nvim-lsp',
+        -- XXX: No releases, looks unmaintained?
+        commit = '39e2eda76828d88b773cc27a3f61d2ad782c922d',
+      }
     },
     config = function()
       -- Brief aside: **What is LSP?**
@@ -616,7 +626,7 @@ require('lazy').setup({
             })
           end
 
-          -- The following autocommand is used to enable inlay hints in your
+          -- The following code creates a keymap to toggle inlay hints in your
           -- code, if the language server you are using supports them
           --
           -- This may be unwanted, since they displace some of your code
@@ -742,6 +752,8 @@ require('lazy').setup({
     tag = 'v7.1.0',
     pin = true,
     lazy = false,
+    event = { 'BufWritePre' },
+    cmd = { 'ConformInfo' },
     keys = {
       {
         '<leader>f',
@@ -769,9 +781,8 @@ require('lazy').setup({
         -- Conform can also run multiple formatters sequentially
         -- python = { "isort", "black" },
         --
-        -- You can use a sub-list to tell conform to run *until* a formatter
-        -- is found.
-        -- javascript = { { "prettierd", "prettier" } },
+        -- You can use 'stop_after_first' to run the first available formatter from the list
+        -- javascript = { "prettierd", "prettier", stop_after_first = true },
       },
     },
   },
@@ -968,7 +979,7 @@ require('lazy').setup({
       --
       -- Examples:
       --  - va)  - [V]isually select [A]round [)]paren
-      --  - yinq - [Y]ank [I]nside [N]ext [']quote
+      --  - yinq - [Y]ank [I]nside [N]ext [Q]uote
       --  - ci'  - [C]hange [I]nside [']quote
       require('mini.ai').setup { n_lines = 500 }
 
@@ -1024,8 +1035,6 @@ require('lazy').setup({
     config = function(_, opts)
       -- [[ Configure Treesitter ]] See `:help nvim-treesitter`
 
-      -- Prefer git instead of curl in order to improve connectivity in some environments
-      require('nvim-treesitter.install').prefer_git = true
       ---@diagnostic disable-next-line: missing-fields
       require('nvim-treesitter.configs').setup(opts)