Hi folks! I've been thinking about admindocs lately and that they would really deserve more attention than they currently get. It's a quite useful feature and I think a very underrated one.
They were initially there to provide documentation for 'front-end people', when working on templates. While this may still be useful, we've already discussed that nowadays it's more common to use admindocs as internal documentation for developers. I think I'd be great if this position was reaffirmed inside the Django project. Some of the ways we could do that: 1. Have that position more clearly stated in the documentation for admindocs 2. Mention admindocs in other parts of the Django documentation. For example, it seems that following FK relations is often a lot easier with admindocs. Maybe that should be mentioned somewhere? 3. Mention admindocs in the tutorial. Not sure about this one, since it could just add unnecessary weight. But it might also make life easier for some people. 4. Add some possible new features: - documenting management commands - having some kind of README per app. Tim Baxter provided an example/possible implementation <https://github.com/tBaxter/tango-shared-core/blob/master/tango_shared/views.py#L40> of this on the irc channel. Anyway, I'd love to hear your thoughts. Best, Žan -- You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group. To unsubscribe from this group and stop receiving emails from it, send an email to django-developers+unsubscr...@googlegroups.com. To post to this group, send email to django-developers@googlegroups.com. Visit this group at http://groups.google.com/group/django-developers. To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/3477f98f-7029-4a35-a3ef-ac41d2a9c8c8%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
