Top
Best
New

Posted by ibobev 1 day ago

The GitHub wiki is an anti-pattern (2022)(michaelheap.com)
172 points | 109 commentspage 4
flobosg 1 day ago|
(2022)
esafak 1 day ago||
Yes, and the rest of it is too; there's another outage today and my CI is blocked. I guess I can read the wikis while I wait, eh?? https://www.githubstatus.com/
shevy-java 1 day ago||
The Github wiki is pretty bad. However had, it is easier to use than issues and coordinating them. Github issues require too much cross-communication and not everyone has the time to meta-coordinate many different issues in many different projects. A wiki lowers the entry-barrier too, so the idea of a wiki is, in principle, good.

If I were Github I would improve the wiki, a bit stylistically, to make it more visually pleasing to use (but not much, those designers always go overboard when making changes in my experience), but much more importantly so, to make the wiki a more flexible addition, including API-wise, usage examples, documentation and so forth. People can, in principle, do so on their own, but also from experience, most people stop doing so after a while, and then the wiki decays into outdated information. That's bad too. Spawning more issues to manage the wiki also does not work well.

ierukah 1 day ago||
In Forgejo, wikis are just another repo, so you have versioning there.
isityettime 1 day ago|
That's also true on GitHub: https://docs.github.com/en/communities/documenting-your-proj...

and on GitLab: https://docs.gitlab.com/user/project/wiki/

It sounds like the whole argument here is that the commits in the docs repo aren't identical commits in the source code repo. But you can ameliorate that with something like tags or submodules. And it's also inherently true of any project with more than one repo, too.

00kee0d 1 day ago||
You own it now, I'll quote you on that!
thedefaultman 1 day ago||
[flagged]
arkonvault 1 day ago||
[flagged]
dayyan 1 day ago||
Duh.
_itsRoze 1 day ago|
It's likely also better that agents seeing versioned /docs can understand the context of changes to the codebase better.