improve discoverability of testing documentation
|Reported by:||Chris Jerdonek||Owned by:||Tim Graham|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
This ticket is to suggest a couple simple high-level improvements to the organization of the testing documentation.
(1) First, the title of the "stub" intro document Testing in Django is too similar to the title of the main testing document Testing Django Applications. If the stub intro page is to have a generic name, the latter should be called something more specific like "Basic Topics in Testing" (to contrast it with the other main testing document called "Advanced Topics in Testing").
(2) Secondly, currently the two substantive testing documents (i.e. the "basic" page and the "advanced" page) don't show up in the table of contents. Only the stub intro page shows up. This makes it harder to find the more meaningful testing pages (because you have to do an extra click and scroll). I think the table of contents should be more like the HTTP section, where the table of contents contains links to both the stub intro page as well as the substantive sub-documents. So it should like something like the following in the table of contents:
- Testing in Django
- Basic Testing Topics
- Advanced Testing Topics
Change History (8)
comment:2 Changed 3 years ago by
|Owner:||changed from nobody to Tim Graham|
|Status:||new → assigned|
|Triage Stage:||Unreviewed → Accepted|