Document the GDoc API more thoroughly

[dnaaun]

No description provided.

[monajalal]

Hi David, I have a suggestion that you use something like WebStorm for Documentation. It has nice rendering of README.md and having the gdoc in a separate README.md say in backend folder, would make it more accessible to all of us.

I know you planned on doing this later, but doing it sooner will favor most of us.

[dnaaun]

Hi Mona, I love text based solutions (like Markdown READMEs) a lot actually. I'd prefer to use them whenever possible.

The problem is that the current documentation format has tables. From past experience, using markdown with tables, especially if you plan on editing the documentation a lot. Is a huge pain, I dont want to spend time doing that right now.

But, if you want to go ahead and convert the documentation to a markdown file on our repo, please go ahead!!