Skip to content

docs(readme): add plugin configuration index with line references #1629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

glaulher
Copy link

@glaulher glaulher commented Jul 5, 2025

Hi! 👋

This PR adds a new ## Configuration section to the README.md that provides quick access to plugin configuration.

The goal is to help users find exactly where each plugin is configured — whether directly in init.lua or in a dedicated file under lua/kickstart/plugins/.

This can be especially useful for:

  • New users trying to understand how each plugin is integrated

  • Users customizing their own config and needing a quick reference

  • Reducing friction when searching through the file

Line references for plugins configured in init.lua have been included for convenience.

Hope this small addition improves usability! Let me know if you'd like adjustments.

Thanks for the great project! 🙏

@glaulher
Copy link
Author

glaulher commented Jul 5, 2025

Note: This PR also includes the changes proposed in #1628.

If the diagnostic enhancements from that PR are not wanted here, I'm happy to adjust the branch and submit only the relevant changes for this one. Just let me know!

@oriori1703
Copy link
Contributor

I do like the idea, but wouldn't that be a pain to update each time a line is added or removed above the linked lines?
Maybe we could just have an easily searchable banner for each plugin, and document that?

Or maybe just greping (or search using /) the plugin name is good enough?

@rivenirvana
Copy link
Contributor

I think it would be more worthwhile to reevaluate #473 instead, which would also nudge new users towards learning how to interact with and navigate between multiple files in neovim, via the defaults it has (commands to buffers, splits & navigation, etc), or via the configuration kickstart provides (telescope, search keymaps, etc).

@guru245
Copy link
Contributor

guru245 commented Jul 6, 2025

image
A friend of mine is managing init.lua like this. 😁Then, we don't have to go through the pain to update comments.

When I want to know what plugin I use, I execute :lazy home. If I want to go to the plugin setting, I run <leader>sg or <leader>s/.

@glaulher
Copy link
Author

glaulher commented Jul 6, 2025

Thanks everyone for the thoughtful feedback!

I’m currently using the modular version of Kickstart by dam9000 (as mentioned in #473), and my idea with this PR was simply to make it easier for new users of Kickstart to locate the exact lines where each plugin is configured — whether in init.lua or in separate files.

That said, I completely agree that maintaining line references manually would introduce unnecessary overhead and could quickly become unmanageable with frequent updates to the codebase.

I’ll go ahead and close this PR — thank you again for the helpful discussion and for all the work on this great project! 🙏

@glaulher glaulher closed this Jul 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants