Feature Request #3879
Split guides from repos
|Assignee:||Woody Gilk||% Done:|
I think it would be beneficial to split the
guide/ directories from each repo into Github wikis, like Bonafide does. This allows the guide to be updated without creating changes to the actual code base (save for submodule updates) and allows anyone to edit the guide, which will increase documentation contributions.
This would simply mean a subtree split to separate the contents and renaming "index.md" to "home.md" to fit Github conventions.
#4 Updated by Lorenzo Pisani about 3 years ago
But a commit to the wiki means a commit to the project anyway because you need to track the submodule, no? So what is this actually solving other than adding twice as many submodules to track?
If the goal is to make people browse the docs on GitHub, then I am very much against this. You cannot style those pages and they are very ugly to look through when the amount of information grows past a certain point.
#6 Updated by Kiall Mac Innes about 3 years ago
Anything that lowers the barrier to entry without other complications is a good thing..
But - Would this really help any more than promoting/encouraging the use of the "edit the file" button? The branches issue seems like a big deal to me.. (I've honestly never used GitHub wiki's .. its likely I'm missing something...)
#8 Updated by Matt Button over 2 years ago
- Status changed from Feedback to Closed
- Resolution set to wontfix
Going to close this as github now provide an easy "fork and edit file" button which makes it easier to contribute.
Also, userguide uses extra markdown formatting (such as [!!]) which github doesn't support