The GitHub wiki is an anti-pattern (2022)

I agree with this post. I’ve never found the GitHub wiki experience to be particularly ergonomic. I don’t have any issues with it, but it’s no more convenient than a simple /docs folder. And from there, it’s almost trivial to turn /docs into GitHub pages. Similar effort for a much better end product. Wikis typically connote distributed, anonymous edits. This feature is partially covered by git already.

• cxr · 19 hours ago

  > I’ve never found the GitHub wiki experience to be particularly ergonomic. That's because the original sin of GitHub "wikis" is that they weren't (and most of them still aren't) even wikis. There's this perverse thing that happened during the wiki age, where people unable or unwilling to get on board decided to just start calling things "wikis" even though they exemplify the very thing that the wiki was invented as a response to. The reckless debasing of the word then infected adjacent spaces. Sourcehut's "read-only wikis" (wat) aren't even designed to be edited in the browser; on Sourcehut, "Publishing your changes is as easy as committing them and pushing them upstream." Newsflash: That's not a wiki .

  • masklinn · 19 hours ago

    Yeah you can configure gh “wikis” to be freely editable but that’s not the default and most of them are not,

Biggest thing for me is wiki edits skip code review, so docs rot silently while a /docs PR at least shows up in the diff next to the change.

• freedomben · 19 hours ago

  Indeed, and also now with agents everywhere the docs can be updated and checked more regularly. If it's in the wiki, you can clone it locally and put an AGENTS.md line informing of where the docs are, but it's still a separate repo to deal with. Credit where due, it was a revolution (even a godsend) in it's time, but at this point I agree a /docs is better.

• nchmy · 19 hours ago

  im having trouble connecting the dots here. How does adding the friction of code review reduce rot?

  • anon48293 · 19 hours ago

    You can spot a code change without a docs change or vice versa

Fossil ( https://fossil-scm.org/home/doc/trunk/www/index.wiki ) solves this pretty nicely. You can have documentation as files or in a special wiki namespace and it's versioned both ways, and every repository clone gets everything. Even better than that, your in-tree documentation files are rendered and browseable in exactly the same way as the dedicated wiki namespace. The linked URL to the home page there can even serve as an example: the "trunk" is a check-in name ( https://fossil-scm.org/home/doc/trunk/www/checkin_names.wiki ) that points to the newest check-in on the "trunk" branch. You can replace it with any other reference to get the old version; eg, version-2.20 would work to get the version 2.20 of the docs, 2015-03-14 would work to get the version from 14 March 2015, etc.

• YPCrumble · 19 hours ago

  Why is this easier or more effective than just a /docs directory?

  • gatlin · 19 hours ago

    Parent comment linked to that answer.

  • chungy · 18 hours ago

    You absolutely can use "just a /docs" directory in Fossil. You can even point the web server to /doc/trunk/docs/index.md or whatever other file names you want. :-)

• mghackerlady · 19 hours ago

  Fossil is the best. Sqlite uses it

  • bigfishrunning · 18 hours ago

    Fossil was written for Sqlite in the same way that git was written for Linux. It's really a shame that more projects don't use it. I think that a github competitor (with social features, PRs, CI, etc) with a fossil backend would be very popular.

    • somat · 10 hours ago

      In fossil's case, every instance includes those features, this makes the social platform "the web itself" Having said that, there are central hosting projects, but where that has some value with git, git proper is distributed and does not need it but all the auxiliary stuff does. with fossil it provides almost no value. All the auxiliary stuff is built in so all it provides is a place to host. Which is fair but hosting is not hard with fossil. https://chiselapp.com/ With everything included in fossil I abuse it as a personal social platform(think discord) super easy to host and it gets me chat, forums, wiki, and file storage. None of them great, but it is so easy I don't really care. voice and video do require an additional service, so there is that. Now I just need to find some friends...

  • rpdillon · 14 hours ago

    Yep, I use Fossil for all my side projects. Super easy to host, tiny, includes everything I need for a project, all in one file. Great piece of software.

    • yellowapple · 11 hours ago

      I've been gradually migrating my Git repos to Fossil as I've been touching them. Been quite happy with it. There are only a couple things that I miss: - Grouping repos together into a combined project. I'd love to be able to have a single Fossil server/instance with a single set of users, wiki pages, tickets, etc. but multiple independent codebases. Closest I've gotten to that is to simply have multiple independent branches instead of a single trunk (example: https://fsl.yellowapple.us/avorion/home ), and it's worked surprisingly well, but it's clear Fossil wasn't designed with this workflow in mind, so there are some rough edges with it (albeit minor and easy to work around). - Compatibility with things that assume you're using Git. Being able to export to Git helps a lot here, but it's still extra steps. Ideal solution here would be for the Fossil server to be able to double as a Git forge and present repos accordingly, such that I can point things like CI/CD pipelines or Terragrunt module calls or whatever directly to the Fossil repo itself over the Git interface those things expect instead of having to setup a Git forge manually and somehow synchronize everything w.r.t. access controls. - An equivalent to Git's submodules. This would IMO help address the “grouping repos together into a combined project” case as well.

      • somat · 10 hours ago

        There are login-group options which lets you have a single sign on with a group of repos, To unify the other bits it looks like it would be possible to change the main menu links to the central repo(in the web settings). Never wanted to do what you want but it sounds possible set up the fossil server on a directory of repos probably with --repolist to get a list fossil server --repolist /var/fossil/ get all repos in the same login-group change the menus in each repo to point to the core repo. Based on some quick tests I suspect a full http:// url is required. - Forum /forum {@2 3 4 5 6} + Forum https://mydomain.org/core/forum {@2 3 4 5 6}

Interesting because I just added a wiki for one of my projects. I'm not using it for docs, since the project already has in-tree docs. I'm using it more as a public scratchpad of ideas / experiments to try that aren't well-defined enough (or known to be worth) opening as an issue yet.

In my experience, the docs for something like setting up a dev env are typically greatly improved by the second person who sets up the dev env, not the personal who originally wrote the docs. In that case, when the docs are not associated with a code change, you want to make getting those improvements into the docs as frictionless as possible, otherwise the changes aren't going to get made. Personally, I've found that making docs updates incredibly fast + easy to be far more valuable than anything you get from forcing doc changes through the full SDLC process. If someone has feedback on your docs changes they would have shared in a review, they can just update the docs instead.

• wavemode · 19 hours ago

  You can set up automation and/or configuration such that changes to the docs folder don't require code review.

• juancn · 19 hours ago

  That could be easily be corrected by relaxing merge gates for changes only to the `docs` folder (or some suitable naming pattern). You can even do live edits on the web if you don't want to use a command line.

• jameshart · 19 hours ago

  Corrections and improvements to docs are just a bugfix though?

• yunwal · 18 hours ago

  > In my experience, the docs for something like setting up a dev env are typically greatly improved by the second person who sets up the dev env, not the personal who originally wrote the docs. In my experience, this is also true of a lot of code as well. Your dev scripts should probably have much more relaxed standards than your service source or CI/CD. Ideally I could define merge requirements by directory without doing some weird shenanigans with the CODEOWNERS file and a bot.

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 · 19 hours ago

  They're not indexed if they're publicly editable

  • jdxcode · 19 hours ago

    also the repo needs 500+ stars https://docs.github.com/en/communities/documenting-your-proj...

    • crazysim · 18 hours ago

      It also needs to be non publically editable. In other words, spiritually not a wiki.

It's likely also better that agents seeing versioned /docs can understand the context of changes to the codebase better.

nit: ”Using the /docs folder is the highest effort-to-reward ratio option” shouldn’t it be lowest or reward-to-effort instead?

In Forgejo, wikis are just another repo, so you have versioning there.

• isityettime · 19 hours 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.

Duh.

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.

In Gitlab the wiki is just a separate git repo. Is this not the case with GitHub?

• masklinn · 19 hours ago

  It is. Although it’s a hidden git repo with none of the GitHub tooling.

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.

The second paragraph neatly triggered my confirmation bias: The initial version of this post opened with “You can use the wiki or a docs folder for your GitHub project, both are valid choices” but as I wrote more, I realised that there is a single reason to use a wiki, and many more reasons not to use the wiki. So many in fact, that I consider using the wiki on GitHub is an anti-pattern. A very straightforward example of McCulloch's quote that "Writing is thinking."

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/

You own it now, I'll quote you on that!

(2022)

I've never understood why people even _generate_ from the docs folder. If you've written it in markdown (which they nearly always do) then it's already rendered properly in Github. Or is it because they then publish those docs somewhere else?

• etatester · 18 hours ago

  I think generation helps with content and structure that GitHub Markdown does not support, as well as having a dedicated (and brandable) website. An example: - source: https://github.com/eslint/eslint/blob/main/docs/src/rules/no... - rendered: https://eslint.org/docs/latest/rules/no-control-regex This is a very simple example, you can see how the code blocks are highlighted better and slightly interactive.

• WCSTombs · 14 hours ago

  > Or is it because they then publish those docs somewhere else? Exactly, I use Sphinx to make a nice website from the markdown sources (although it doesn't have to be markdown). That includes generating a full API reference page from all the docstrings.

A lot of GitHub’s secondary features are like this. The Issues tab and Discussions tab are so similar, with slightly different feature sets. And users will happily use both for feature requests and bug reports, with varying degrees of quality, so then I just have yet another thing to stay on top of. I think Discussions were made to reduce noise in very busy repos, but I generally find something useful in the noise. It’s really just a way to ignore users. As a result, I always turn off Discussions and just let people file issues when they feel it’s appropriate.

I agree, but my only gripe is I hate the ceremony required for doc-only updates. It needs a review and CI. The review is a good thing in most cases (want your docs to be correct), but that often takes my team like two days (I'm realizing this is likely our fault now that I'm typing this). For CI, I've just added in a step to all our GitHub actions to skip Markdown only changes. Anyone have any better ideas?

• jamwil · 18 hours ago

  Use CODEOWNERS files to route docs/ reviews differently.

  • jjice · 17 hours ago

    We're small enough of a team that everyone can review anything (with a bit of domain expertise in there). It's less of an issue of who is reviewing and more of an issue of getting anyone to spend a minute to look at it. More of a human problem. Would be curious what people to do remedy this.

• pocksuppet · 17 hours ago

  If your process is bothering you, change your process - it's in your control. Write a new bullet point: "doc-only updates can skip review and CI". When you make a doc-only update, you click the "skip checks and merge anyway" button. Some people are so preoccupied with making sure things can only be done a certain way, they don't stop to think about whether it's the right way. Of course someone will object to doc-only updates not getting review. That person is now on the hook for reviewing all doc updates after you merge them. It's the exact same thing you were doing before - they only objected when it got formalised.

The last paragraph says: > At some point your docs will outgrow a single folder, and then all bets are off. You’ll want a separate repo with its own build process... My question is, why is this taken as a given? Is it so hard to have docs and code live together in version control after a certain scale? If so, what is the specific problem and what is the cause? I ask because I've never been that satisfied with the various ways I've tried to organize projects in git. Recently I've been trying to keep the source, tests and docs together in the same tree so that changes are more localized. It seems to be helping me keep track of things, especially with coding agents so eager to make changes all over the place. I find their proclivity to repeat the same idea in multiple locations (agent instructions, docs, docstrings, help strings, comments) especially problematic.

• TheRoque · 18 hours ago

  I also put everything in one repo nowadays, no matter the usage, the language etc. All is synced, and all is accessible by my LLM. There are a lot of tools to manage monorepos, and frankly most of the time you don't even need them.

  • ffsm8 · 17 hours ago

    It makes releasing software a lot more complicated. Not a big deal if you're basically the only developer and handroll the process - but poly repositories make release and dependency management a lot more straightforward to wrangle

  • bluGill · 17 hours ago

    Most of the time your repo is so small that you won't run into the problems of a large repo and so you don't need those tools. Don't confuse that for monorepos have no problems when they get large.

    • genxy · 14 hours ago

      How large is large? What does large mean? More than 100GB? 2TB?

      • bluGill · 14 hours ago

        You have the wrong measure. Large is number of parts. That is partially source files, partially projects/teams, and partially things that are conceptually not related. Likely other things as well. It is unlikely GB/TB is ever a measure, though if your repo is that big and some people only need a subset of the repo it would be.

        • jonjon10002 · 13 hours ago

          Worked at a place (as a tech writing manager) where the monorepo was several TB and company-issued laptops all had 500 GB hard drives. It was like a rite of passage that new writers or people with new laptops would inevitably not RTFM or learn about sparse checkout and try to clone the entire repo, which was not good.

          • genxy · 11 hours ago

            Nice hazing ritual, I hope that behavior extended to other parts of the organization.

• johannes1234321 · 18 hours ago

  > Is it so hard to have docs and code live together in version control Managers and others won't touch the repo. (Sometimes it's better the don't...)

  • ragall · 12 hours ago

    We had managers and even non-engineers check-in documentation at Google: each page had an "Edit me" button that spawned an editor in a new tab with a CL(PR) ready. It worked very well.

• bluGill · 17 hours ago

  On a large project you will have problems. You can maintain a monorepo anyway as many people do, and deal with the problems of a large monorepo. Or you can go to multirepo and deal with the issues of multirepo. Both have been done successfully, and both have significant problems that you need to work with. Most people advocating a monorepo have never worked on a project large enough to see the issues with a monorepo and so are arguing for a monorepo without understanding the problems with them. For most people a monorepo is the correct answer because their project is small.

  • dualvariable · 17 hours ago

    Seems like if you're small enough, a monorepo is the right way to go because it doesn't matter at that scale, and if you're big enough, you'll have the resources to throw at making monorepos scale.

    • bluGill · 16 hours ago

      Mono vs poly at scale needs resources. You have different compromises with each and so the resources go to different places. However there is no clear cut winner despite a few mono repo at scale advocates trying to claim otherwise - they are always completely ignoring the issues with a monorepo setup.

      • dualvariable · 16 hours ago

        Multirepo at scale also needs resources, there's an enormous amount of work required for version bumping and synchronizing everything. People always completely ignore all those chores. Generally, you have either a massive amount of tech debt or you have one person doing nothing but running around doing all that work for everyone else (works great if all that work seems to magically appear for you). You can also be furiously working at automating all those chores, but that's the same level of effort you'd have to throw at scaling out a monorepo--just different.

        • bluGill · 15 hours ago

          That was my point - there are issues with both at scale. Trying to pretend that one is better for everyone is wrong. You just choose your tradeoffs.

      • sshine · 12 hours ago

        Exactly because monorepos have least overhead when they’re small, monorepos generally win because you need to be small for a long while until you get big. By the time you’re “at scale” (who knows), and all these monorepo at scale problems start to overwhelm, you can switch strategy, because the economy of polyrepos is so obvious by then. So far, I’ve started a new job a handful of times by collapsing a premature polyrepo strategy: people were not experienced enough to merge two git repos without a common root. I’ve only once went the other way, and it incurred so much overhead, it decreased developer productivity by some small but not insignificant percentage. To be clear: I’m not a maximalist. All of my open-source work is exceedingly compartmentalised. My DNS library is separate from my external-dns webhook is separate from my fork of external-dns. They could all live in one repo. But FOSS encourages reusability, commercial software encourages clumping and vendoring.

        • gilfaethwy · 11 hours ago

          > By the time you’re “at scale” (who knows), and all these monorepo at scale problems start to overwhelm, you can switch strategy, because the economy of polyrepos is so obvious by then. Conversely to your experience, I have worked at a handful of places who have a monorepo that has been creaking under its own weight for years, but its structure as a monorepo now underpins the business, and so migration to a polyrepo simply never happens, and developers are now checking out a 50GB repo in its entirety periodically.

          • horsawlarway · 8 hours ago

            I'm on the other side of this problem, with a company that went multi repo for bad reasons (political, not technical) and I would give you serious money if you could solve my problems by just forcing me to check out 50gb every now and then... Instead I deal with a 30+ repo clusterfuck (technically we have 60+ services, but I only have to run half...) that is held together by hopes and prayers, takes literal hours of actual effort to bring everything up to date on master, and has become a fractured hellscape where people are afraid to leave their tightly constrained silos of service combinations. Long story short... I will take a bad monorepo over bad multirepo any day of the week.

            • bluGill · 7 hours ago

              I suspect that your hours of effort to get everything up to date would exist in a monorevel, too. It would exist in a different form, and so it would be harder to measure, but a large part of the work has to be done either way. It's just that certain parts of the work become very visible.

            • dualvariable · 4 hours ago

              Yeah, compared with the maintenance effort of running around to 100 different repos, keeping everything in sync and the deps all updated, I'd always take the pain of 50GB checkouts.

  • cortesoft · 15 hours ago

    > Most people advocating a monorepo have never worked on a project large enough to see the issues with a monorepo Really? I feel like most of the stuff I have read advocating monorepos are from people at Google, which is a HUGE monorepo.

    • bluGill · 14 hours ago

      Google is an advocate of monorepo. However a lot of people are seem to be regurgitating what google wrote about them, but they are not Google scale and have no idea what the problems Google faces are. Google also is very much in the yell loudly and ignore anyone who points out the problems of a monorepo.

      • cortesoft · 10 hours ago

        Maybe it is just because I know a lot of Googlers/ex-Googlers, but almost all of the advocates for monorepos that I have spoken to are basing it from their experience at Google. I won't disagree that they tend to gloss over the extensive tooling they have to make it work, though...

    • ibobev · 10 hours ago

      Isn't Microsoft also using a monorepo?

• darau1 · 16 hours ago

  Weirdo checking in I always initialize my projects with a src, and docs, directory, for exactly this reason. My reasoning is that I shouldn't have to go hunting for the docs for the code, or vice versa.

  • guipsp · 13 hours ago

    Do you have only those two dirs at the top level? If so how are you finding it? I tend to have a docs dir at the top level, along with other build stuff

    • darau1 · 12 hours ago

      I've had no trouble so far. I'd have no problem with ephemeral build artifacts going either at the root, or in src. edit: I have had one pain point: devs/managers ask me why I do that, and that I stop. I refuse.

• giancarlostoro · 14 hours ago

  > I find their proclivity to repeat the same idea in multiple locations (agent instructions, docs, docstrings, help strings, comments) especially problematic. I have not taken full advantage yet, but every source sub-directory can have its own CLAUDE.md or AGENTS.md file, with instructions for a given directory, whenever something like Claude opens a file in a folder, if there's an appropriate agent doc in the housing folder, it should read / apply its contents when working. Not sure how this happens with Sub-Agents on that note. I think if you want both, you might as well add a ./docs/ directory, and put your md documents in there however you want, this has the upside of letting you have docs with your code always, as well as letting you link to direct source code files.

I think there is a missing pro here on the wiki side: trivial edits are trivial. Even fixing a typo in the docs directory requires PR + approvals + CI. Effectively limiting your docs contributors to folks who are comfortable with a code editor, and git, is a decision

• Kinrany · 18 hours ago

  Forcing CI and approvals on changes to docs/ is a decision

  • swiftcoder · 17 hours ago

    Entertainingly, excluding a directory from PR approvals is not an option GitHub provides out of the box

    • pocksuppet · 17 hours ago

      Then don't do approvals. Comment "approved" and if someone merges without someone else commenting "approved" someone gets mad at them.

      • swiftcoder · 16 hours ago

        One can always work around tools limitations. The limitations tell us something about how the creators intended it to be held, however

I'm no fan of GitHub add-ons and I agree with the premise here but... I can think of one other possibility. It's easier to write in a wiki via the browser. I can open that on my phone and edit docs. I can open it in my browser and edit docs. On desktop it's a tiny bit more to pull the repo and open it in your editor (and you might already be there) but that tiny bit can be enough to stop you from writing documentation. For me, writing documentation must be totally painless so that I'll actually do it. Why am I not a fan of the add-ons like PR's, wiki's, discussions, projects, and issues? Because they each introduce vendor lock-in to varying degrees.

• cocoto · 18 hours ago

  You can edit single files in most git forges and it will open a pull request for you, the workflow is not that bad.

• wky · 18 hours ago

  GitHub is pretty good about editing on the web. Markdown files can be edited straight from github.com. On desktop you can hit the period key to directly open the repo in vscode.dev. Technically on mobile you can change github.com to github.dev to do the same, though the editing experience is worse than directly editing on GitHub.

• sheept · 17 hours ago

  Wikis don’t have as much vendor lock-in as other Github features since they’re just git repos,[0] so you can clone and push the wiki elsewhere. [0]: https://docs.github.com/en/communities/documenting-your-proj...

To consider, there are different docs: in repo (can be wiki format): - dev docs - user manual different repo: - community usage wiki

https://github-wiki-see.page/ I've been trying for years to get the contents indexed, accessible to search engines or even AI. When I started, no wiki was ever indexed but it seems GitHub backed off a bit since then. Still, there's a bunch that is still not indexed for various reasons with valuable data in them. I do agree, most users should look into docs instead.

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.

Not many people know that the github wiki is actually backed by a separate "hidden" repo, and can be accessed by adding .wiki to the repo url, e.g. https://github.com/lionleaf/dwitter.wiki.git Apparently it can even do CI stuff. Still wouldn't recommend it though, for the other reasons outlined in TFA and this thread.

• annex-winged-cr · 17 hours ago

  It leads to a 404 page on my end.

  • sheept · 17 hours ago

    It’s not a web page; it’s a git remote url

• WorldMaker · 17 hours ago

  I seem to recall that GHE allowed you at one point to point a Wiki to a /docs or /docs/wiki subdirectory. I still don't know why that never became a public GitHub.com feature. Sure it is technically redundant with the file browser if you know how to use the view controls and don't mind the UI sprawl of the file browser, but I still think it would be a good feature.

• isityettime · 13 hours ago

  It's in the docs, so it's not exactly hidden: > You can edit wikis directly on GitHub, or you can edit wiki files locally . https://docs.github.com/en/communities/documenting-your-proj... > Every wiki provides an easy way to clone its contents down to your computer. Once you've created an initial page on GitHub, you can clone the repository to your computer with the provided URL. Every GitHub wiki you visit also has a section at the bottom that points to that URL with the description > Clone this wiki locally as well.

> 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.

I tried to make the GH Wiki work and managed to address 6 of the 7 concerns brought up in the article using a GH Action to mirror a directory of docs. It was my first GH Action and proved to be trickier than I thought. For those who just need to expose some markdown and don't want to bother with gh-pages you might find it useful: https://github.com/super-productivity/super-productivity/blo... The generic-ness of the wiki wasn't an issue for me as I only intended on using it as a temporary measure to build up the bulk of the content and coordinate with the main dev on finding a balance between the flashy website with its guides and the less flashy docs. gh-pages is the obvious next step of course.

• AriedK · 16 hours ago

  I took the same approach. Every merge into main triggers the GH Action to sync /docs with the wiki. The advantages of a wiki over /docs are tiny but the single click, navigation sidebar with all headings was enough for me to deal with the GH Actions hassle. GH Pages was no option because we are not on Enterprise and parts need to remain private.

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 · 15 hours 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.

The GitHub wiki is not a real wiki. It cannot be edited by most people.

I completely agree. When the docs are in the same repository as the source code, at least you can keep the documentation atomically synced to the code. No other method allows this (not counting setups with Git submodules, which is the same thing with more steps), and that should be an immediate dealbreaker. Docs being updated to reflect the code can then (and must, IMO) be a blocking constraint on all pull requests.

I disagree, requiring code review for docs changes sounds great but in my experience it's extremely hard to get a human to review docs changes. Either you get a rubber stamp with no real review (zero added value, adds useless friction) or you spend days bugging people to actually review your changes. All for docs! The counter-argument i envision is: "update your docs and code at the same time in the same PR!" That works great, until you want to document something that isn't precisely tied to a single piece of code. In fact I think the most useful docs describe high level systems rather than being associated with specific pieces of code. Use comments for that; in contrast, docs should be easily editable by anyone at all times, otherwise they never get updated (an evergreen problem in any scenario).

• yellowapple · 11 hours ago

  This'll be a controversial answer, but this sounds like exactly the sort of thing an LLM should be able to do reasonably well, whether by the human writing the docs and the LLM updating the code accordingly or by the human writing the code and the LLM updating the docs accordingly.

• anon7000 · 7 hours ago

  Agreed, but I think the review & CI system should ideally be able to ignore markdown changes. Easier said than done. But I think the biggest benefit, which we shouldn’t overstate, is that agents will just update docs as they find them. Including for big picture systems. Keeping docs updated is a PITA. Writing style of AI often sucks. But I’ve found it pretty easy to rectify. And having some correct context is better than nothing or outdated docs in a lot of cases.

In a startup with move-fast lightweight processes: 1. Docs that are naturally versioned with the code, like API doc or a design doc, might well go in the code repos. (I'm personally a big fan of API docs embedded in comment chunks right above the respective implementation chunk, but a separate Markdown or SVG file, or other format, also works.) 2. Everything else, one of the top priorities is to minimize friction to someone who has the information capturing it such that it can be found by someone else later , so put it in the very low-friction wiki (or an issue/task comment). 3. Have a lightweight way of cross-linking things between these locations, that everyone knows, so info is more likely to be found later. This still applies even if you feed everything into AI now.

If you make the wiki an actual Git submodule, the main repository does pin a specific wiki commit.