Opened 4 hours ago

Last modified 3 hours ago

#37051 assigned Cleanup/optimization

Improve the map of documentation on Django's home page — at Version 1

Reported by: Daniele Procida Owned by:
Component: Documentation Version: 6.0
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Daniele Procida)

In general, the documentation home page does an outstanding job of unfolding Django’s documentation content in a topographical fashion – it’s like opening a map and seeing the terrain laid out in front of you.

It's rational, compact and shows the relationship of different concerns to each other very effectively.

However some of the rationality frays at the edges, and it's not maintained all the way down. Currently, it exposes, in order:

I propose reworking this map of Django's domains of concern so that things like each other are closer together. For example: features (e.g. Admin, Forms, GeoDjango), quality demands (Security, Performance) and so on.

Here's a sketch of the new arrangement of domains of concern. It attempts to achieve a balance of rationality, pragmatism (no heavy-handed application of rules if it would produce something awkward) and aesthetics (it should provide a good experience, feel good and even look right).

It orders topics as:

  • entry-point
  • conceptual and functional layers
  • features
  • resources and interfaces (a new grouping, concerned with Django's access to the world outside it)
  • quality demands
  • development lifecycle activity
  • contributing to Django

and sometimes uses those categories as actual titles too.

Change History (1)

comment:1 by Daniele Procida, 3 hours ago

Description: modified (diff)
Has patch: set
Note: See TracTickets for help on using tickets.
Back to Top