Documentation should live in the same repo as the code

  • Documentation review should be part of the code review.
    • By forcing us to store the documentation in the same repository, we can keep it up-to-date with the code directly.
    • We can catch missing documentation updates in PRs while doing code reviews.
  • The documentation is versioned in a way in Git that ensures it aligns with the same version of the code, thus automatically synchronizing its history with older versions of the app.
  • Question: how we can migrate existing documentation from an external wiki into the repository?