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

docs: add installation and build guides from wiki to repo #26533

Merged
merged 1 commit into from Dec 13, 2023

Conversation

dundargoc
Copy link
Member

No description provided.

@dundargoc dundargoc marked this pull request as ready for review December 12, 2023 15:45
BUILD.md Outdated Show resolved Hide resolved
@clason
Copy link
Member

clason commented Dec 12, 2023

We should also update the links in

  1. README.md
  2. Wiki Home.md

@wookayin
Copy link
Member

wookayin commented Dec 12, 2023

How about having a top-level docs/ folder?

EDIT: NVM, if we are not moving all the docs from wiki but only build/installation instructions, I think it will be enough.

@clason
Copy link
Member

clason commented Dec 12, 2023

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! 🥳 )

@dundargoc dundargoc force-pushed the docs/install branch 4 times, most recently from cbe6fc1 to d5e7812 Compare December 12, 2023 17:48
@clason
Copy link
Member

clason commented Dec 12, 2023

Possible follow-ups (note for future reference):

@justinmk
Copy link
Member

these two files are special since they are mainly useful before you have built and/or installed Neovim

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 runtime/doc/*.txt files using relative paths so there isn't really a discoverability issue there.

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.

@clason
Copy link
Member

clason commented Dec 13, 2023

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.)

INSTALLING and BUILDING are also typical files in a source repo, so much more visible to people coming here.

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.

@justinmk
Copy link
Member

Fair enough.

@dundargoc
Copy link
Member Author

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.

@dundargoc dundargoc merged commit fbd0f66 into neovim:master Dec 13, 2023
25 checks passed
@dundargoc dundargoc deleted the docs/install branch December 13, 2023 16:53
@github-actions github-actions bot removed the request for review from bfredl December 13, 2023 17:05
dundargoc pushed a commit that referenced this pull request Jan 26, 2024
Change the link to point to INSTALL.md.

The contents were moved in #26533
altermo pushed a commit to altermo/neovim-fork that referenced this pull request Jan 26, 2024
Change the link to point to INSTALL.md.

The contents were moved in neovim#26533
altermo pushed a commit to altermo/neovim-fork that referenced this pull request Jan 26, 2024
Change the link to point to INSTALL.md.

The contents were moved in neovim#26533
konosubakonoakua pushed a commit to konosubakonoakua/neovim that referenced this pull request Feb 4, 2024
Change the link to point to INSTALL.md.

The contents were moved in neovim#26533
glepnir pushed a commit to glepnir/neovim that referenced this pull request Mar 31, 2024
Change the link to point to INSTALL.md.

The contents were moved in neovim#26533
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.

None yet

4 participants