Move documentation to a separate repo

[nik-rev]

Right now Helix's documentation lives in the book directory. But I think it can be beneficial to move it to a separate repository, like helix-editor/docs:

• Decreases maintenance burden. All issues and PRs related to the documentation live in that repository

• Push and merge access can be handed out much more freely.

  Right now the maintainers that review pull requests also have to review documentation PRs. Reviewing documentation changes takes away time from reviewing code-related PRs.

  It'll mean changes to documentation will be merged quicker as well.

• If we want to port the following wiki pages to the official documentation:

  • Debugger Configurations
  • Formatter Configurations
  • Language Server Configurations

  Then that will further mean that the docs are edited more often. It'll become harder for the maintainers to review every little PR such as "Add X formatter for X language"

So, any thoughts on this?

[david-crespo]

Big downside: functionality changes would no longer be together in one commit with the corresponding docs changes. I do not think it reduces maintenance burden. I doubt they really want to give out docs approval permissions to a bunch of people.

[nik-rev]

Maybe not a bunch of people, but few select people who are known in the community and want to volunteer. Even if there are like 3 new people that can approve doc PRs, that'll already be a big deal.

It will reduce maintenance burden, simply because there will be more maintainers for the docs.

I agree that having 2 PRs, one which adds functionality, and another which adds the documentation be in different repos can be problematic. Especially when some of the documentation is generated with the source code.

Wait, I don't think this will work anymore. I just now realised this may not be possible because many places in the documentation get automatically generated.

[nik-rev]

Closing because I realised this would be more trouble than its worth, because some parts of the documentation are generated from the source code.