3 ms·
> It's a different beast, and doesn't belong in the repo alongside the implementation. That's just, like, your opinion, MaxBarraclough. If they aren't in the r
by m0zg 7y ago
> It's a different beast, and doesn't belong in the repo alongside the implementation.
That's just, like, your opinion, MaxBarraclough. If they aren't in the repo, they're never going to get updated, and as a result they will be outdated within 6 months on any project that's moving anywhere. I prioritize freshness of documentation against most other attributes. It does nobody any good to have documentation for the system as it was 2 years ago.
- MaxBarraclough 7y agoI take it you agree that high-level documentation shouldn't take the form of comments in source-code. > If they aren't in the repo, they're never going to get updated Not so. The Qt folks use a separate repo for their documentation. [0] My point earlier was that high-level documentation is a separate project than the implementation. You could keep the high-level documentation documents in the same repo as the implementation if you want, that's just a monorepo. [0] https://github.com/qt/qtdoc https://github.com/qt/qtdoc