Documentation

[digitalextremist]

Complete GitHub Wiki or GitBook:

• definitions of Terms used
• API basics & example usage
• means of extending/expanding.

[sarahzrf]

"Definitions used" meaning (method, class, module) definitions in the code, or definitions of technical terms?

[digitalextremist]

Terms. Ideally API information separately. Will update ticket.

[sarahzrf]

@digitalextremist can you take a look at the writing I've done on the wiki and at the doc that YARD generates from the comments I've done, and give me some feedback on where I stand wrt this goal and what needs more work?

[digitalextremist]

@benzrf it seems like some of the content is coming together, but now it needs to be organized... and any lacking sections need to be marked. I would prefer a GitBook be made, but that's not the important thing.

Mostly we need a Table of Contents with direct links to the content. Even if it's a single page markdown file in the repo, that's fine... that would possibly even be better.

But the second-best case in my view would not to be to depend on GitHub wiki features but include docs/ with inter-connected markdown.

Like I said though, best case is GitBook. Most important thing is that the outline exists and anything not written is marked as TODO on the outline as we normally would whether it be GSoC or not.

[digitalextremist]

What if we use this to store/format the documentation:
http://stackoverflow.com/tour/documentation

[sarahzrf]

I dunno how I feel about getting tied to some SaaS.

[sarahzrf]

GitHub wikis are at least just a frontend to a repo full of markdown files