Clarification on where to place example configuration snippets
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- lua
- Domain
- documentation
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.
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?
- Dominant language
- Lua
- Stars
- 99
- Forks
- 136
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from LazyVim/lazyvim.github.io
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
LazyVim/lazyvim.github.io#146 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
LazyVim/lazyvim.github.io#119 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
LazyVim/lazyvim.github.io#176 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
LazyVim/lazyvim.github.io#171 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 38/100
LazyVim/lazyvim.github.io#154 · 1 reaction ·
All issues in LazyVim/lazyvim.github.io
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
codymikol/multiverse.nvim#330 ·
Maintainers usually reply within 8 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Mosquito needs triage
Difficulty 1/5 Under an hour Newbie friendliness 91/100
DCS-Skunkworks/dcs-bios#1919 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
Mudlet/Mudlet#11182 · 2 comments ·
Maintainers usually reply within 1 day
-
import-issue
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
public-transport/transitous#2519 ·
Maintainers usually reply within 1 day