Move opam-repository documentation from the Wiki into the main repo #28022
Description
Similar to #26992, I think we should move most of the rest of the constant from the Wiki into the repo. Here are the benefits I expect:
- Currently there is no way to suggest changes, additions, or fixes to the documentation, unless you have write perms to the repo wiki. Moving the docs into the repo would allow us receive PRs to suggest improvements.
- We will have more flexibility with structure and formatting (e.g., could use subdirectories to structure topics).
- It will be much easier to track the history of changes.
- Changes to the docs will be visible to others via the PRs needed to make changes.
In general, I think the reasoning driving this suggestion is that GitHub wiki's are not just that great for organizing documentation.
The main downside is that it will take a little longer to introduce changes, but IMO this will be compensated for by the increased visibility, accessibility, and tracking.
This was discussed in the maintenance meeting today, and @mseri and @raphael-proust thought it seemed reasonable.
We also agreed that we should leave all the current pages in the wiki and add links directing to the new locations for the content, to prevent breaking old links.