commnets

init.lua

@@ -1,18 +1,19 @@
 -- River Rooks nvim config
--- init.lua
--- render options, keybinds, lazy and treesitter
--- processed first
---
--- render options
+-- /init.lua
+-- This file is the first thing nvim renderes on boot. 
+-- from here we tell it to load the options and  keybinds files, as well as bootstrap Lazy, our plugin manager
+
+-- execute the following files in the /lua directory
 require('options')
--- render keybinds
 require('keybinds')
--- bootstrap lazy.nvim
 require("config.lazy")
--- lazy.nvim settings 
+
+-- now that we have loaded our basic settings and started lazy, we need to configure lazy to our liking
 require("lazy").setup({
   spec = {
+    -- execute all files is /lua/plugins -- this is where I put plugins with more complex setups
     { import = "plugins" },
+    -- import the following list of plugins -- this is where i put plugins with minial settings
     {
       'tpope/vim-commentary', -- commenting lines with shortcut 
       -- 'vimpostor/vim-tpipeline', -- integrate with tmux status-line
@@ -31,14 +32,16 @@ require("lazy").setup({
       { "denialofsandwich/sudo.nvim", dependencies = { "MunifTanjim/nui.nvim",  },config = true, }, --write restricted files without restart
       { 'akinsho/toggleterm.nvim', version = "*", config = true}, -- terminal toggling and commands
       { 'nvim-java/nvim-java', config = function() require('java').setup() vim.lsp.enable('jdtls') end, }, --jave QOL
-      { 'RRethy/base16-nvim', config = function() require('matugen').setup() end,}, --colorshceme for noctalia integration
+      -- disable matugen if not using noctalia shell
+      { 'RRethy/base16-nvim', config = function() require('matugen').setup() end,}, --colorshceme for noctalia integration 
+
       { "lervag/vimtex", lazy = false, init = function() vim.g.vimtex_view_method = "zathura" end }, -- for latex editing
       { 'windwp/nvim-autopairs', event = "InsertEnter", config = true },
       { "folke/ts-comments.nvim", event = "VeryLazy", }, -- qol for commenting
     },
   },
   -- Configure any other settings here. See the documentation for more details.
-  -- colorscheme that will be used when installing plugins.
+  -- colorscheme that will be used when installing plugins before loaded the matugen plugin for desktop colorscheme.
   install = { colorscheme = { "miniautumn" } },
   -- automatically check for plugin updates
   checker = { enabled = true },
@@ -49,7 +52,7 @@ if theme_ok then
     matugen.setup()
 end
 
--- setup lsp
+-- load lsp and bufferline plugins 
 require("config.lsp")
 -- render bufferline
 require("bufferline").setup{}

lua/keybinds.lua

@@ -1,3 +1,7 @@
+--/lua/keybinds.lua 
+-- This file defines all of the kybinds for nvim.
+-- vim.keymap.set('mode','<modifier>key','action', {desc = 'description'})
+
 -- move betwwen buffer easier
 vim.keymap.set('n', '<Tab>', ':bnext<CR>')
 vim.keymap.set('n', '<S-Tab>', ':bprev<CR>')

lua/options.lua

@@ -1,4 +1,6 @@
--- River Rooks nvim config
+-- /lua/options.lua
+-- This file is where i set all of the options and settings for nvim
+
 
 -- [[setup]]
 vim.g.mapleader = ' '