neovim.github.io
neovim.github.io copied to clipboard
neovim
doc: restore uri neovim.io/doc
would rather revert the doc/general/ thing and go back to having a single doc/ landing page. The content of doc/lsp/, doc/treesitter/, etc. does not justify separate landing pages.
would rather revert the
doc/general/thing and go back to having a singledoc/landing page. The content ofdoc/lsp/,doc/treesitter/, etc. does not justify separate landing pages.
I don't have a strong opinion on that and will defer to whoever does the work.
However, this PR definitely won't work because doc/ is served by the neovim/doc repo. Either we merge that repo into here (and make the git history noisier) or we fix the generation of the website so https://neovim.io/doc/ works again.
or we fix the generation of the website so https://neovim.io/doc/ works again.
yep, not sure where it went wrong, i guess the doc/index.html went missing
I didn't know multiple pages were discouraged. I like the multiple pages though: I created the different pages before the 0.5 release as a way to introduce people to the new features. That's why the pages are light. Now that 0.5 is released, more content could be added (while keeping it simple, but for instance mention lspinstall along with lspconfig), which wouldn't be as nice on a single page ? Especially as I think we may need to add more in the future (regarding all the recent talk about best practice for plugin development). Neovim doc is good but there is little on the website (a lot on the wiki) but hosting some on the website looks neater IMHO.
I think the automated repo should serve neovim.io/docs/generated and not neovim.io/docs, it would make things cleaner/easier
Especially as I think we may need to add more in the future (regarding all the recent talk about best practice for plugin development). Neovim doc is good but there is little on the website (a lot on the wiki) but hosting some on the website looks neater IMHO.
the website is not the primary source of truth. Detailed things should live mostly in the user manual and generate to the website.
There is no hard and fast rule that "multiple pages are discouraged", but it should solve a problem. The current tree is a solution looking for a problem.
Trying to fit the constraint of "all on one page" leads to useful questions like "do we actually need X or Y". Answer is "no" for some of the things under doc/ currently.
What is the Language Server Protocol ? has no business being under doc/, for example. Yet that's all there is in the LSP page. Because we didn't really have any reason for that page to exist.
We do need a "feature showcase" page, which will take the place of the current screenshots/ page. That is where we can mention things like "What is LSP", briefly.
What is the Language Server Protocol ? has no business being under doc/, for example.
I disagree, we've got tons of questions about what is LSP, what's the difference with treesitter, what is lspconfig, how it interacts with neovim and so on. It's a unique feature of neovim and if you have never used neovim, how are you supposed to know how to use LSP in neovim ? You have no nvim installed so :h is out of the question (plus it's tough for beginners). I think we need to mention lspconfig here. Is it worth having mutiple pages, maybe not. But I can imagine this going up a bit. We could add animations to showcase the feature. I would prefer it on a lsp page rather than https://neovim.io/screenshots/ .
FWIW, I've restored the https://neovim.io/doc/ URL in #271. I'll let you guys decide on how to handle the broader issue that Justin raised, but the 404 is now fixed.