DistrictDataLabs / partisan-discourse

A web application that identifies party in political discourse and an example of operationalized machine learning.
http://partisan-discourse.districtdatalabs.com/
Apache License 2.0
27 stars 8 forks source link

Added documentation in Mkdocs format #19

Closed samgoodgame closed 8 years ago

samgoodgame commented 8 years ago

The user guide section isn't complete, and I also need to add content about how administrators manage machine learning models for users, etc. I'll likely need to have a Google Hangout or come in person to go over that stuff thoroughly enough to be able to write docs on it.

coveralls commented 8 years ago

Coverage Status

Coverage remained the same at 41.828% when pulling e369d80e4b5ee8731192be8306fc7272571d2864 on samgoodgame:develop into 039fb90c5782695e5556c3b79993b285e972bc50 on DistrictDataLabs:develop.

bbengfort commented 8 years ago

@samgoodgame looking good! I made a few changes to the theme and other meta information in order to better reflect DDL branding (just the stuff we have in Trinket and other places). I also moved your docs/docs folder to the top level (docs) -- there wasn't really a need to keep my old stub documentation around now that you've written something up!

The next step is to get this on readthedocs.org -- which we'll work on whenever you're comfortable. I'll create an issue for that now.

samgoodgame commented 8 years ago

Ok! I'll look it up and see if I can't figure it out. Regardless, though, the documentation doesn't really cover the more technical aspects of integrating the machine learning pieces of the project into the Django architecture--so I imagine that when that's all set up (I assume it's not yet?) then I'll get the project set up locally and write a section of the docs explaining the process.

bbengfort commented 8 years ago

@samgoodgame don't worry if you don't want to take that on right away; it's simple and you and I can do it together if you'd like. The main thing is to join the org and to pull the changes I made to your documentation so you can keep going.