search

LunarVim / Launch.nvim

🚀 Launch.nvim is modular starter for Neovim.
GNU General Public License v3.0
2k stars 474 forks source link

Document thinking behind structure and naming conventions #121

Closed gbroques closed 1 year ago

gbroques commented 1 year ago

Hi, thanks for the work on this project. It's been immensely helpful to me on my Neovim journey as I recently switched from VS Code.

Can we document the thinking behind the structure and naming conventions?

For example, there are some modules in lua/ like Lazy, autocommands, keymaps, and options.

While modules to configure plugins reside in lua/user with the same name as the plugin.

As someone new to Neovim, it's not obvious that we namespace these under user/ to avoid conficts with the plugin itself.

Also, it seems autocommands, keymaps, and options could have been in user which was the case for the older Neovim-from-scratch.

Why the change? Does it have something to do with Lazy?

Why include "lazy.nvim" over "packer.nvim" like Neovim-from-scratch had?

What about a brief explanation of settings and utils? In Neovim-from-scratch, settings was in lua/user/lsp/settings instead of lua/settings.

Anyways, some further explanation about the structure of the project and naming conventions would help someone like me who's brand new to Neovim.

Thank you!

MickTheRus commented 1 year ago

I'm considering writing a wiki for it to explain our choices in naming convention, file, etc.

MickTheRus commented 1 year ago

@gbroques I've made a wiki for all the topics described there. Right now it only has the lazy VS packer, I'm currently working on the config tree and explaining what different parts do

MickTheRus commented 1 year ago

https://github.com/LunarVim/nvim-basic-ide/wiki/config_tree

gbroques commented 1 year ago

Thank you for your work on this @MickTheRus.

I think we can close this out.

I'll have a read, and see what I can learn! :)

Rishabh672003 commented 1 year ago

@gbroques i also made a wiki for adding new plugins https://github.com/LunarVim/nvim-basic-ide/wiki/adding_new_plugins if you have any suggestion do open issue or reply here, its my first time making a doc so yeah