Documentation needed?

Open Leo-Ryu opened this issue 5 years ago • 1 comments

Hello,

My name is Leo and I’m a CS student-- Recently, I’ve been working on a platform for editable codebase documentation.

I came across this repo while browsing GitHub and noticed it lacked documentation. Do you mind if I create docs for your repo? I'm sincerely hoping it will be useful for your needs.

Dec 15 '20 09:12 Leo-Ryu

Hi @Leo-Ryu - thanks for reaching out!

While in principle yes, I'm not sure that this relatively stale, low maintenance project is the best for you (Ill let you decide on this).

Were you thinking about writing some docs in Sphinx and hosted on ReadTheDocs? This is what I'm familiar with, and any other tool would probably be too much of a maintenance burden for me in the future...

Dec 16 '20 10:12 fmaussion