django-tasks
django-tasks copied to clipboard
RealOrangeOne
Documentation
Any good project needs documentation. Because of the depth of this package, piling it all into the README isn't going to suffice.
Perhaps a CONTRIBUTING.md file wouldn't be a bad idea if you'd like people to join. Also, do you plan on uploading the docs on readthedocs?
readthedocs feels like as good of a platform as any - lets us keep different versions live.
CONTRIBUTING.md is probably also needed, but I think is separate to documentation.
Thinking of taking this on as a intro to the project and then some contributions afterwards. Do you have a preferred tool? mkdocs/sphinx/etc? Update: Django itself uses Sphinx as mentioned here. I would suggest consistency with it
Much of the documentation already exists on https://github.com/django/django/pull/18627.
Sphinx is fairly heavy. Given most of the documentation will be duplicated from Django, we'll want something very simple. mkdocs is also fine.
Given the current scope, a giant README isn't that bad
Given the existance of the docs for DEP 14 on Django, what is the scope of the documentation here compared to there? (i.e. are there specific things to be documented here that are not there? there but not here?)
Probably not much. The intention is for django-tasks to be 100% API compatible (at least a subset of) with the Django API. So most of the documentation may be covered there. It might just be a case of linking out (once it exists).