kickstart.nvim icon indicating copy to clipboard operation
kickstart.nvim copied to clipboard

May I add comments about "lua is a programming language" and "lua is embedded-> the global vim exists" to init.lua?

Open Weyaaron opened this issue 1 year ago • 2 comments

Dear all,

I would like to contribute something, but I would like to know if this is "accepted". I would rather ask first then write something with care and not use it. This is inspired by my own experience, I used kickstart back in the day and it helped a lot. There are two concepts I that I feel like are missing and could speed up learning even more.

"Lua is an actual programming language": This is mentioned, but it is buried deep in the code and its impact is not discussed properly. I feel like a small dedicated paragraph/section with some really easy examples could go a long way to improve the visibility of this fact.

"Lua is embedded->Existence of the global vim ': I feel like the existence of the global vim is not motivated/explained at all. It just exists, but it is not mentioned how or why and what the implications are. (There are no mentions of "global" or "embedded" anywhere in the document). While this is a somewhat technical topic, I feel explaining it could improve understanding of the setup quite a lot.

Let me know what you think, based on the feedback I will start writing some first drafts soon. I am open to including either but not the other.

Weyaaron avatar Feb 21 '25 08:02 Weyaaron

I think this could be helpful, as long as the explanations are short and to-the-point. Would be worthwhile to link the help docs that explain it in further detail as well.

Crypto-Spartan avatar Mar 26 '25 23:03 Crypto-Spartan

Hiya! If you make the changes I suggested or suggest alternatives I'll merge it.

feoh avatar Apr 09 '25 21:04 feoh