Skip to content
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

README does not explain what this repo does #3202

Closed
hk0i opened this issue Jun 10, 2024 · 2 comments · Fixed by #3327
Closed

README does not explain what this repo does #3202

hk0i opened this issue Jun 10, 2024 · 2 comments · Fixed by #3327
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@hk0i
Copy link

hk0i commented Jun 10, 2024

Description

I can see that a lot of careful work and planning went into this repository and I appreciate the effort that went into this project.

It appears like the README doesn't explain what this repository is for and how it's useful. It's only until I installed the plugin, then ran :help lspconfig that I was able to determine that this repository is a collection of configurations.

I'm sure it's obvious for those who are already into it but this is my first time seeing lua in general, and I don't really know what the pros/cons are to this over something else or even if there's an alternative. I'm actually trying to follow a guide to set up Swift support in nvim, and even from the guide I followed I'm not sure if I need this repository or if I just need to create a lua configuration file of my own.

  1. Is lua configuration built into neovim or does this plugin add support for it?
  2. Is this a plugin actually or is this just a bunch of community vim configurations?

I know most of these seem like silly questions but the README feels like it's geared to people who already know why they are here and that might be why I'm lost. While the instructions on installing are fairly clear it's still not clear to me why I need any of this in the first place.

Thanks again

@hk0i hk0i added the bug Something isn't working label Jun 10, 2024
@justinmk
Copy link
Member

justinmk commented Jun 10, 2024

first 2 lines:

Configs for the Nvim LSP client (:help lsp).

image

however, it could be clearer. and needs some explanation.

@justinmk justinmk added the documentation Improvements or additions to documentation label Jun 10, 2024
@justinmk justinmk self-assigned this Jun 10, 2024
@hk0i
Copy link
Author

hk0i commented Jun 10, 2024

Thanks for the quick response.
That makes sense, maybe something like,

"A collection of user-contributed configuration files for the Nvim LSP client"

Thanks again!

justinmk added a commit that referenced this issue Sep 29, 2024
- improve overview for newcomers
- call out plan for upstreaming "framework" parts to Nvim core
- guide bug reports to neovim core
- remove most mentions of wiki

fix #3202
@justinmk justinmk mentioned this issue Sep 29, 2024
justinmk added a commit that referenced this issue Sep 29, 2024
- improve overview for newcomers
- call out plan for upstreaming "framework" parts to Nvim core
- guide bug reports to neovim core
- remove most mentions of wiki

fix #3202
justinmk added a commit that referenced this issue Sep 29, 2024
- improve overview for newcomers
- call out plan for upstreaming "framework" parts to Nvim core
- guide bug reports to neovim core
- remove most mentions of wiki

fix #3202
justinmk added a commit that referenced this issue Sep 29, 2024
- improve overview for newcomers
- call out plan for upstreaming "framework" parts to Nvim core
- guide bug reports to neovim core
- remove most mentions of wiki

fix #3202
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants