Hacker News new | past | comments | ask | show | jobs | submit login

I 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




Consider applying for YC's Spring batch! Applications are open till Feb 11.

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: