Docs with diagrams in github projects? [closed]

Question

I'd like to write an architecture document for a little ruby project I'm working on, and being an architecture document it'll benefit from a few box and stick diagrams.

What's the done thing on open source projects for this situation? Should I be practicing my ASCII art, or should I include PDFs or something in my doc folder?

Note that this is a stand-alone document, not API documentation generated from the code.

Answer 1

Check out umlet-github, a Google Chrome extension that allows you to create diagrams in UMLet, store them as UXF files in your repository and view them in your browser within the GitHub interface.