feature: Add hint to docs about lazy.nvim setup

[Javex]

Did you check the docs?

• [X] I have read all the neoconf.nvim docs

Is your feature request related to a problem? Please describe.

I just installed neoconf for the first time, using lazy.nvim. However, the plugin wasn't getting imported. I realised this is happening because there is no opts in the example which was originally included in https://github.com/folke/neoconf.nvim/pull/48 which even includes an explanation.

However, this means that I had to do a bunch of debugging before I realised what was going on.

Describe the solution you'd like

Some update to the docs so that users aren't confused by this. If I understand correctly, because users need to ensure neoconf is loaded first, you don't want users blindly copying the line and ending up with a broken neoconf. I had actually added neoconf as a dependency to nvim-lspconfig , but that alone obviously that alone doesn't fix it.

I might be missing something, but could a full example look like this:

  {
    "folke/neoconf.nvim",
    cmd = {
      "Neoconf",
    },
    opts = {},
  },
{
    "neovim/nvim-lspconfig",
    -- Add this to your nvim-lspconfig to ensure neoconf is loaded first
    dependencies = { "folke/neoconf.nvim" },
  },

If this is the correct config, I'm happy to make a PR, if it's not then I've set it up wrong and would appreciate some help in what to do better.

Describe alternatives you've considered

I think the issue is fixed for me, but I'm sure I won't be the last neovim newbie to step into this trap. Or maybe I did something else wrong?

Additional context

No response

[github-actions[bot]]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[Javex]

I still think this is worth having in the docs

[github-actions[bot]]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[github-actions[bot]]

This issue was closed because it has been stalled for 7 days with no activity.