Plugin documentation is confusing

[tf42src]

I am trying to write a plugin and run it locally.

According to the specification dev is a boolean?, but clicking on the config.dev link, dev is a table [1]. That's confusing.

Another thing I find confusing is that the page is headed Plugin Spec. What is shown is the spec for including a plugin, but not the actual spec for the plugin, correct?

[1] https://lazy.folke.io/configuration

dev = {
    ---@type string | fun(plugin: LazyPlugin): string directory where you store your local plugin projects
    path = "~/projects",
    ---@type string[] plugins that match these patterns will use your local versions instead of being fetched from GitHub
    patterns = {}, -- For example {"folke"}
    fallback = false, -- Fallback to git when local plugin doesn't exist
  }

I didn't log a ticket, because this is neither a bug nor a new feature.

I have another follow up question: can dir be relative (e.g "./example.nvim") or do I need to use an absolute path (e.g. "~/example.nvim") ? It would be nice if I could place my plugin code somewhere in my .config/nvim directory.

[iton0]

If you use the plugin spec dev that is a boolean. The config.dev link shows the default config for the lazy.nvim plugin manager itself. It has spec named dev which is a table.

Here is minimal example how you would do that:

require('lazy').setup({
  {
    'mylocalplugin',
    dev = true,
  },
}, {
  dev = {
    -- For this example, you would have a subdirectory named 'mylocalplugin' in the directory below
    path = '~/neovim_dev/',
  },
})

To your follow up question I am unsure but try relative and see if it works. I hope this is helpful.