Skip to content

Fixed #17638 -- Improve navigation between CBV pages #2975

Closed
wants to merge 1 commit into from

3 participants

@jarus
jarus commented Jul 26, 2014

Added "see also" blocks for navigation between introduction
and api reference of class based views.

Thanks to mcintyre94 who provide the initial patch.

@timgraham
Django member

Left feedback on ticket.

@jarus jarus Fixed #17638 -- Improve navigation between topic and reference pages
Added "see also" blocks for navigation between introduction/topic
and api reference.

Thanks to mcintyre94 who provide the initial patch.
431199d
@schmitch schmitch commented on the diff Aug 2, 2014
docs/topics/forms/index.txt
@@ -7,8 +7,12 @@ Working with forms
.. admonition:: About this document
This document provides an introduction to the basics of web forms and how
- they are handled in Django. For a more detailed look at specific areas of
- the forms API, see :doc:`/ref/forms/api`, :doc:`/ref/forms/fields`, and
+ they are handled in Django.
+
+.. seealso::
+
+ For a more detailed look at specific areas of the forms API, see
+ :doc:`/ref/forms/api`, :doc:`/ref/forms/fields`, and
@schmitch
schmitch added a note Aug 2, 2014

Currently in this document there is already a reference to the forms/api.
Look at the bottom.
https://github.com/jarus/django/blob/431199dbe1c9bebe4688d49e375002a4bc947eae/docs/topics/forms/index.txt#L746

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@schmitch
schmitch commented Aug 2, 2014

I noted a duplicate in one of the documents.
Also I think that the See Also Boxes should be at the bottom. Like it is done in the forms/index.txt
They could also be Linked like it is done in forms/index.txt
So you could write a "Further Topics" section.

But maybe a core contributer thinks the other way so maybe we need some input in here.

@timgraham
Django member

I agree and left a reply on the ticket with more details.

@timgraham
Django member

@jarus, do you want to update this? If not, might be a good ticket for a new contributor at DjangoCon next week to pickup where you left off.

@jarus
jarus commented Aug 29, 2014

@timgraham Excuse me I hadn't much time for open source stuff.

It would be great if a new contributor could take over this issue/ticket.

@timgraham
Django member

Thanks, will close this PR then.

@timgraham timgraham closed this Aug 30, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.