News for hackers. Stuff that matters.
Re:Ask HN: How do you organize software documentation at work? by simonw on Wednesday February 14, 2024 @10:57AM (#39371398)
The main reason is that if it's in Git you can enforce this policy through your PR process.

There are a bunch of other reasons to keep documentation in git. The most important is that it gives you versioned documentation that matches your releases - if someone is running v2.3 of your software they can browse the documentation for that exact version using that tag on GitHub.

If your documentation lives in some other system it can only ever attempt to be accurate for whatever the most recent release is. This is bad for people running older versions, and also makes it harder to develop documentation for unreleased code in a way that isn't potentially confusing.

Re:Ask HN: How do you organize software documentation at work? by robertlagrant on Wednesday February 14, 2024 @04:15PM (#39375495)
Understood; I'm particularly talking about using bugs rather than making sure things are ready in PRs.