liballocs icon indicating copy to clipboard operation
liballocs copied to clipboard

Wiki content needs expanding

Open difcsi opened this issue 5 months ago • 4 comments

I'm just adding this issue as I keep forgetting to focus on getting my notes on liballocs into the wiki at https://github.com/stephenrkell/liballocs/wiki

Hopefully, I'll be reminded to do it the next time I'm around the issue tracker

difcsi avatar Sep 09 '25 13:09 difcsi

See #61 for recent comments

difcsi avatar Sep 09 '25 13:09 difcsi

Oh, I was not aware of this existing!

alethkit avatar Sep 09 '25 18:09 alethkit

Since I hope to migrate off GitHub at some point, and because I like the idea of committing docs at the same time as committing to code (albeit difficult in practice!), I still favour keeping essential technical documentation in the repo. However, there is still probably a role for an external wiki too, especially for "how to?" or "why is...?" or "common problems" topics. So maybe it is OK to use the GitHub wiki for that and I will worry about the migration story later.

stephenrkell avatar Sep 10 '25 13:09 stephenrkell

I completely agree! Plus, the GitHub wiki is essentially just a separate repo with md files anyway, it is quite easy to migrate from!

difcsi avatar Sep 10 '25 14:09 difcsi