Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#26272 closed New feature (needsinfo)

Add documentation on how to build a homepage/table of contents

Reported by: Malik A. Rumi Owned by: nobody
Component: Documentation Version: 1.9
Severity: Normal Keywords: Home page, Table of Contents
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Tim Graham)

  1. Building a home page

I posted this to [django-users], and while responding to Bob I realized this might need to be a feature request, so I'm here making it. Here's the link:

  1. Building a Table of Contents

This is another area where getting solid information is hard to come by. I am NOT talking about using Sphinx or anything like that. This is not for documentation, it is for a Table of Contents for end users of the site. Such tables are typically hierarchical, which requires either a 3rd party app or a judicious use of parent child relationships. And while we can use ListView as a starting point, what about features that spread across different apps, or don't have strictly hierarchical relation but that you still want to list together somehow?

I am perfectly willing to work on this, (I have lots of non-technical writing experience) even alone, so long as I had the ear of Django experts who would respond to issues I run into or questions I have about how it should all work, best practices, etc.

Change History (3)

comment:1 Changed 3 years ago by Tim Graham

Description: modified (diff)
Resolution: needsinfo
Status: newclosed
Summary: Additional Documentation on Common FeaturesAdd documentation on how to build a homepage/table of contents

I don't see where this would fit into the docs. I think it's really too broad a topic to give general guidance without making specific recommendations that are usually project specific. If you want to try to write something, but all means, feel free to propose it but until we see the details, I don't think there's much value in keeping a ticket like this open. Hope not to discourage you!

comment:2 Changed 3 years ago by Malik A. Rumi

hmmm.... ok, what about a handful of examples for different use cases?

comment:3 Changed 3 years ago by Tim Graham

I'd have to see more specifics of what you have in mind to say whether or not its appropriate for the Django docs.

Note: See TracTickets for help on using tickets.
Back to Top