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

Advertise nvim-lua-guide in docs #14332

Merged
merged 1 commit into from
Apr 9, 2021
Merged

Advertise nvim-lua-guide in docs #14332

merged 1 commit into from
Apr 9, 2021

Conversation

clason
Copy link
Member

@clason clason commented Apr 9, 2021

Mention https://github.com/nanotee/nvim-lua-guide at the beginning of :h lua as well as :h lua-vimscript.

Closes #12369 .

@clason clason requested a review from mhinz April 9, 2021 14:17
@clason clason added this to the 0.5 milestone Apr 9, 2021
runtime/doc/lua.txt Outdated Show resolved Hide resolved
@mhinz mhinz merged commit 1b030f8 into neovim:master Apr 9, 2021
@teto
Copy link
Member

teto commented Apr 9, 2021

I am not comfortable with referencing an external website. Some users will keep Neovim 0.5 for years (we have people in the chat using 0.2 ...) so I would prefer an url we control. The github wiki would be nice but even better would be a link to the website IMO.
I would like to add LSP/Treesitter/Lua sections to https://neovim.io/doc/ even if it just redirects to external resources, at least we can provide some context for the URI ("this guide is good for 0.5, this one for 0.6 and so on").

@clason clason deleted the shill-for-nanotee branch April 9, 2021 17:38
@clason
Copy link
Member Author

clason commented Apr 9, 2021

@teto
Copy link
Member

teto commented Apr 9, 2021

Looking at it right now

@mhinz
Copy link
Member

mhinz commented Apr 9, 2021

We can pull it in to a server/site we control and everything, but actually I want to do less. Even if automated, it all adds to the overall complexity.

So, when the repo is active and the community considers it a good resource, let them manage it. And maybe we have more frequent releases in the future, so advertising shouldn't be a big deal anyway. :)

@clason
Copy link
Member Author

clason commented Apr 9, 2021

Alternatively, we can put a link to it in the README, adding "Lua integration" as a new feature point, then "see :h lua and "?

@teto
Copy link
Member

teto commented Apr 9, 2021

see neovim/neovim.github.io#214 for a follow up

raymond-w-ko pushed a commit to raymond-w-ko/neovim that referenced this pull request Apr 10, 2021
Mention https://github.com/nanotee/nvim-lua-guide at the beginning of ":h lua" as well as ":h lua-vimscript".

Closes neovim#12369 .
@clason clason restored the shill-for-nanotee branch June 9, 2021 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: getting started with lua
3 participants