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
docs: add installation and build guides from wiki to repo #26533
Conversation
9e308fa
to
b2681b8
Compare
We should also update the links in
|
How about having a top-level EDIT: NVM, if we are not moving all the docs from wiki but only build/installation instructions, I think it will be enough. |
b2681b8
to
13d1aba
Compare
Yes, these two files are special since they are mainly useful before you have built and/or installed Neovim. For everything else, the goal is to move that into actual (vimdoc) help documents eventually (after pruning/updating), or offload to neovim.io. (Also, welcome to the team! 🥳 ) |
cbe6fc1
to
d5e7812
Compare
Possible follow-ups (note for future reference):
|
Can we also put these in runtime/doc/ :) Because the website needs an "Install" page, and might as well also give it a "Build" page. The README can link to the Of course we could have a special-purpose "Install" page on the website, but I'd rather focus on perfecting one page instead of multiple pages. It also drives improvements to :help, such as URL rendering, images, etc. |
They're quite heavy on the links, though, which would make them significantly harder to navigate after pushing them through the gen_html_help sausage grinder... So I'd consider those help improvements to be a blocker for the move. (I've looked into reference link parsing for vimdoc and maybe using OSC8, but it's not trivial.)
So I'd prefer to leave them here, at least for now; this round of cleaning is not the last round -- after we've cleaned out the Wiki, the next step will be consolidating (and moving) all the various markdown files. |
9489f60
to
42bc930
Compare
Fair enough. |
Personally I don't mind either way, except that I want this done speedily so the information isn't fragmented in two repos for long. Let's move forward with this for now so we can clean up the wiki and we can deliberate more on how to best present this information later. |
Change the link to point to INSTALL.md. The contents were moved in #26533
Change the link to point to INSTALL.md. The contents were moved in neovim#26533
Change the link to point to INSTALL.md. The contents were moved in neovim#26533
Change the link to point to INSTALL.md. The contents were moved in neovim#26533
Change the link to point to INSTALL.md. The contents were moved in neovim#26533
No description provided.