Top
Best
New

Posted by ibobev 1 day ago

The GitHub wiki is an anti-pattern (2022)(michaelheap.com)
172 points | 109 commentspage 3
a1o 1 day ago|
I really wanted the wiki to at minimum have directories so they would be easier to structure and allow even for major versions that are maintained in parallel.
spider-mario 1 day ago||
The section “How about the reasons not to use the wiki?” is written rather confusingly. It mixes points that apply to the wiki (“The documentation isn’t available locally when someone clones your repo”) and points that apply when not using the wiki (“Documentation edits get the same treatment as code”) without making it clear which one is which – you have to infer it yourself.
fny 1 day ago||
> You can get to the wiki contents in a single click from anywhere in the repo There is no 2.

2. Non-technical people can work with tools they know.

3. You may not want to deal with pull, push, merge for every edit.

4. You may not want to deal with PRs for every edit.

5. Setting up `/docs` takes work. Wikis are just there.

Mintlify and others turned this sort of convenience into a business.

singpolyma3 1 day ago||
The GitHub wiki is not a real wiki. It cannot be edited by most people.
amai 1 day ago||
How do people deal with log files, images, excel files, pdfs and other binary data which they need for documentation. Do you just put everything into the repo at /docs ?
zufallsheld 1 day ago|
It it's text data, yes absolutely inside the docs folder, (maybe an assets subfolder). I didn't have the need yet to put binary data in the docs, but depending on the size it could be in the repo itself or a separate artifact store.
singularity2001 1 day ago||
If you make the wiki an actual Git submodule, the main repository does pin a specific wiki commit.
azatom 1 day ago||
To consider, there are different docs:

in repo (can be wiki format):

- dev docs

- user manual

different repo:

- community usage wiki

jdxcode 1 day ago||
i was going to say the biggest reason wasn't mentioned here, that github sets Disallow: /*/wiki*

however I think maybe this has changed? I don't see it in https://github.com/robots.txt now

david_allison 1 day ago|
They're not indexed if they're publicly editable
jdxcode 1 day ago||
also the repo needs 500+ stars https://docs.github.com/en/communities/documenting-your-proj...
crazysim 1 day ago||
It also needs to be non publically editable.

In other words, spiritually not a wiki.

preisschild 1 day ago|
In Gitlab the wiki is just a separate git repo. Is this not the case with GitHub?
masklinn 1 day ago|
It is. Although it’s a hidden git repo with none of the GitHub tooling.
More comments...