time to proof read

init.lua

@@ -4,18 +4,19 @@
 ==================== READ THIS BEFORE CONTINUING ====================
 =====================================================================
 ========                                    .-----.          ========
-========          .----------------------.  | === |          ========
+========         .----------------------.   | === |          ========
-========          |.-""""""""""""""""""-.|  |-----|          ========
+========         |.-""""""""""""""""""-.|   |-----|          ========
-========          ||                    ||  | === |          ========
+========         ||                    ||   | === |          ========
-========          ||   KICKSTART.NVIM   ||  |-----|          ========
+========         ||   KICKSTART.NVIM   ||   |-----|          ========
-========          ||                    ||  | === |          ========
+========         ||                    ||   | === |          ========
-========          ||                    ||  |-----|          ========
+========         ||                    ||   |-----|          ========
-========          ||:Tutor              ||  |:::::|          ========
+========         ||:Tutor              ||   |:::::|          ========
-========          |'-..................-'|  |____.|          ========
+========         |'-..................-'|   |____.|          ========
-========          `"")----------------(""`   ___________     ========
+========         `"")----------------(""`   ___________      ========
-========         /::::::::::|  |::::::::::\  \ no mouse \    ========
+========        /::::::::::|  |::::::::::\  \ no mouse \     ========
-========        /:::========|  |==hjkl==:::\  \ required \   ========
+========       /:::========|  |==hjkl==:::\  \ required \    ========
-========       '""""""""""""'  '""""""""""""'  '""""""""""'  ========
+========      '""""""""""""'  '""""""""""""'  '""""""""""'   ========
+========                                                     ========
 =====================================================================
 =====================================================================
 
@@ -174,7 +175,16 @@ if not vim.loop.fs_stat(lazypath) then
 end
 vim.opt.rtp:prepend(lazypath)
 
--- [[ Configure plugins ]]
+-- [[ Configure and install plugins ]]
+--
+--  To check the current status of your plugins, run
+--    :Lazy
+--
+--  You can press `?` in this menu for help.
+--
+--  To update plugins, you can run
+--    :Lazy update
+--
 -- NOTE: Here is where you install your plugins.
 require('lazy').setup({
 
@@ -378,7 +388,7 @@ require('lazy').setup({
       -- Additional lua configuration, makes nvim stuff amazing!
       'folke/neodev.nvim',
 
-      -- Useful status updates for LSP
+      -- Useful status updates for LSP.
       -- NOTE: `opts = {}` is the same as calling `require('fidget').setup({})`
       { 'j-hui/fidget.nvim', opts = {} },
     },
@@ -514,6 +524,11 @@ require('lazy').setup({
       })
 
       -- Ensure the servers above are installed
+      --  To check the current status of installed tools and/or manually install
+      --  other tools, you can run
+      --    :Mason
+      --
+      --  You can press `g?` for help in this menu
       require('mason').setup()
       require('mason-tool-installer').setup { ensure_installed = ensure_installed }
       require('mason-lspconfig').setup {
@@ -576,17 +591,24 @@ require('lazy').setup({
         },
         -- For an understanding of why these mappings were
         -- chosen, you will need to read `:help ins-completion`
+        --
+        -- No, but seriously. Please read `:help ins-completion`, it is really good!
         mapping = cmp.mapping.preset.insert {
           -- Select the [n]ext item
           ['<C-n>'] = cmp.mapping.select_next_item(),
           -- Select the [p]revious item
           ['<C-p>'] = cmp.mapping.select_prev_item(),
+
           -- Accept ([y]es) the completion.
           --  This will auto-import if your LSP supports it.
           --  This will expand snippets if the LSP sent a snippet.
           ['<C-y>'] = cmp.mapping.confirm { select = true },
-          -- Manually trigger a completion from nvim-cmp
+
+          -- Manually trigger a completion from nvim-cmp.
+          --  Generally you don't need this, because nvim-cmp will display
+          --  completions whenever it has completion options available.
           ['<C-Space>'] = cmp.mapping.complete {},
+
           -- Think of <c-l> as moving to the right of your snippet expansion.
           --  So if you have a snippet that's like:
           --  function $name($args)
@@ -638,7 +660,7 @@ require('lazy').setup({
     lazy = false, -- make sure we load this during startup if it is your main colorscheme
     priority = 1000, -- make sure to load this before all the other start plugins
     config = function()
-      -- load the colorscheme here
+      -- Load the colorscheme here
       vim.cmd.colorscheme 'tokyonight-night'
 
       -- You can configure highlights by doing something like
@@ -655,11 +677,15 @@ require('lazy').setup({
       -- Better Around/Inside textobjects
       --
       -- Examples:
-      --  - `af` - around function call
+      --  - ya)  - [Y]ank [A]round [)]parenthen
-      --  - `inq` - inside next quote
+      --  - yinq - [Y]ank [I]nside [N]ext [']quote
+      --  - ci'  - [C]hange [I]nside [']quote
       require('mini.ai').setup { n_lines = 500 }
 
       -- Add/delete/replace surroundings (brackets, quotes, etc.)
+      -- - saiw) - [S]urround [A]dd [I]nner [W]ord [)]Paren
+      -- - sd'   - [S]urround [D]elete [']quotes
+      -- - sr)'  - [S]urround [R]eplace [)] [']
       require('mini.surround').setup()
 
       -- Simple and easy statusline.
@@ -689,7 +715,7 @@ require('lazy').setup({
       -- There are additional nvim-treesitter modules that you can use to interact
       -- with nvim-treesitter. You should go explore a few and see what interests you:
       --
-      --    - Incremental selection: Included with nvim-treesitter, see :help nvim-treesitter-incremental-selection-mod
+      --    - Incremental selection: Included, see :help nvim-treesitter-incremental-selection-mod
       --    - Show your current context: https://github.com/nvim-treesitter/nvim-treesitter-context
       --    - Treesitter + textobjects: https://github.com/nvim-treesitter/nvim-treesitter-textobjects
     end,