On Fri, Mar 5, 2010 at 11:35 AM, stherrien <shawntherr...@gmail.com> wrote: > What I'm suggesting is that we setup something to allow everyone to > improve the docs with help from the core django group. I think this > would be very helpful to everyone. if one of the core group would like > to help us get setup to do this it would be great. maybe if they setup > a repository with the current online docs online so we can add updates > as we do with django itself.
So everyone else already answered your concern above, Anyway, regarding your first question, see the "Global Module Index". It contains full import paths to each module and links to the docs for that module wherever they may be (howtos, ref, etc). But yeah, the individual docs should probably include import paths as well. http://docs.djangoproject.com/en/1.1/modindex/ As far as general organization goes, the "Table of Contents" is more helpful imo. I see the front page as more of a highlight of interesting things intended for those taking their first look at the project, but the table of contents gives a much better overview of how everything is actually organized by document section etc. The urls even match the pattern used here, and the "next" and "previous" links follow the order of documents here. http://docs.djangoproject.com/en/1.1/contents/ Both are linked to from every doc page in the sidebar to the right (In the "Browse" section). > > On Mar 5, 11:20 am, stherrien <shawntherr...@gmail.com> wrote: >> Exactly my point docs need to be more organization to be constructive >> for django users. >> >> On Mar 5, 11:05 am, Jared Forsyth <ja...@jaredforsyth.com> wrote: >> >> > To be honest I am quicker to just go to django's source code rather than >> > the >> > docs, as often I can find what I need there, and the docs aren't (imo) >> > organized enough to provide much of an advantage. >> >> > On Fri, Mar 5, 2010 at 8:46 AM, stherrien <shawntherr...@gmail.com> wrote: >> > > Hi all, >> >> > > I have a request that django documentation show the import locations >> > > for classes like in other well formed docs found on the web showing >> > > the users where the classes can be found for import. I think this >> > > would be handy for newer users and experienced users finding something >> > > new. Documentation on the site is different from page to page. Take >> > > for instance the file object doc page in django doesn't tell the user >> > > where this can be imported which requires you to dig into the python >> > > help pages to try and find it. which is "from django.core.files.base >> > > import File". it would be nice to show this consistently across the >> > > site. I would be happy to help make this happen. >> >> > > -shawn >> >> > > -- >> > > You received this message because you are subscribed to the Google Groups >> > > "Django developers" group. >> > > To post to this group, send email to django-develop...@googlegroups.com. >> > > To unsubscribe from this group, send email to >> > > django-developers+unsubscr...@googlegroups.com<django-developers%2bunsubscr...@googlegroups.com> >> > > . >> > > For more options, visit this group at >> > >http://groups.google.com/group/django-developers?hl=en. > > -- > You received this message because you are subscribed to the Google Groups > "Django developers" group. > To post to this group, send email to django-develop...@googlegroups.com. > To unsubscribe from this group, send email to > django-developers+unsubscr...@googlegroups.com. > For more options, visit this group at > http://groups.google.com/group/django-developers?hl=en. > > -- ---- \X/ /-\ `/ |_ /-\ |\| Waylan Limberg -- You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to django-develop...@googlegroups.com. To unsubscribe from this group, send email to django-developers+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/django-developers?hl=en.
