Not all notes belong in shared source code. I take notes on overall code structure and oddities, but also debug output, commands I've run, daily todos, thoughts on papers, experimental results, etc.
I used to save markdown files to git, but 1.) search was difficult and 2.) sometimes I wanted to see the evolution of a project while other times I wanted notes by day.
This project aims to make it easier to record and recall knowledge that teams need and take for granted. I tend to think about onboarding new members, how projects are run, and very specific, technical challenges not on Stack Overflow.
I'm open to feedback. I want to continue to push down a wiki/knowledge base path, but i'm not sure how other teams currently manage stale knowledge and dissemination of technical info.
Notes are structured differently than source code. My notes contain things like tasks, each affecting many source files, sometimes dozens, design notes affecting the code globally, and even plain brain dumps, which would be best left unshared.
Personally, I generate at least as much prose in notes as I do lines of source code, so there would also be readability issues.
I used to save markdown files to git, but 1.) search was difficult and 2.) sometimes I wanted to see the evolution of a project while other times I wanted notes by day.
This project aims to make it easier to record and recall knowledge that teams need and take for granted. I tend to think about onboarding new members, how projects are run, and very specific, technical challenges not on Stack Overflow.
I'm open to feedback. I want to continue to push down a wiki/knowledge base path, but i'm not sure how other teams currently manage stale knowledge and dissemination of technical info.