TL;DR
Documentation should be in the same git repo as it's main project
Long version
I understand git-extras have recently moved the long winded contents of Readme.md into Github's wiki. It is a good thing as Readme.md has become too long and at some point has become difficult to maintain.
Having said that, I do think that the HEAD of each wiki ref should stay in sync with the HEAD of each pull request. This ensures that documentations are not left out and encourage script discovery.
@hemanth has been tirelessly advising pull requesters to update the wiki on every successful review. Perhaps we could be suggested that unless documentations are updated, the PR will not be merged?
Proposed solution (simple)
Since Github's wiki is also a Git repo, we can merge it into the main repo without losing history or refheads. Effectively retiring Github wiki.
What are your thoughts on this?
TL;DR
Documentation should be in the same git repo as it's main project
Long version
I understand
git-extrashave recently moved the long winded contents ofReadme.mdinto Github's wiki. It is a good thing asReadme.mdhas become too long and at some point has become difficult to maintain.Having said that, I do think that the
HEADof each wiki ref should stay in sync with theHEADof each pull request. This ensures that documentations are not left out and encourage script discovery.@hemanth has been tirelessly advising pull requesters to update the wiki on every successful review. Perhaps we could be suggested that unless documentations are updated, the PR will not be merged?
Proposed solution (simple)
Since Github's wiki is also a Git repo, we can merge it into the main repo without losing history or
refheads. Effectively retiring Github wiki.What are your thoughts on this?