LazyVim / LazyVim/lazyvim.github.io

Clarification on where to place example configuration snippets

Open
#76 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
99
Forks
136
PR merge metrics
No merged PRs in 30d

Description

I am confused about where to place my lsp configuration options. For example, for clangd, should I use .../lua/plugins/clangd.lua? Apologies, I am quite new to the system and I have been reading the docs for the last few weeks but not managed to figure out the answer.

I can of course get there by trial and error, but would it be possible to add some headers to the documentation on pages such as in lsp.md to make it clear where I would put the example configuration settings to use lazyVim in the anticipated way?

I am a lua novice, so sorry if this question makes little sense! If the change I am proposing makes no sense maybe we could just have a link in the getting started page for other documentation new users ought to read?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/plugins/lsp.md and review how its configuration examples are organized. Clarify where users should place LSP configuration snippets such as clangd settings, or link to the relevant guidance from the getting started page. Done means a new user can identify the expected location without relying on trial and error.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.