Opened 13 years ago

Closed 11 years ago

Last modified 11 years ago

#16357 closed Cleanup/optimization (fixed)

Navigation buttons in Docs footer would be helpful

Reported by: ncoghlan@… Owned by: Markus Amalthea Magnuson
Component: Documentation Version: 1.3
Severity: Normal Keywords:
Cc: markus.magnuson@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: yes

Description

The Django documentation only provides next/previous buttons in the side bar and not in the page footer. That means after reading a page, you may need to scroll up an arbitrary distance to find the navigation options.

It would be nice to follow the example of the Python docs here and also include the navigation links in the page footer.

Attachments (3)

django-docs-bottom-nav-mockup-01.png (190.2 KB ) - added by Markus Amalthea Magnuson 11 years ago.
Mockup of how a previous/next-bar at the bottom of docs pages could look like.
django-docs-bottom-nav-mockup-02.png (217.0 KB ) - added by Markus Amalthea Magnuson 11 years ago.
Mockup of how a previous/next-bar at the bottom of docs pages could look like.
16357.png (13.7 KB ) - added by Tim Graham 11 years ago.

Download all attachments as: .zip

Change History (18)

comment:1 by Julien Phalip, 13 years ago

Triage Stage: UnreviewedAccepted
UI/UX: set

Good idea -- this would improve the doc's browsability in general.

comment:2 by Julien Phalip, 13 years ago

Owner: changed from nobody to Julien Phalip

comment:3 by Julien Phalip, 12 years ago

Owner: Julien Phalip removed

comment:4 by inductor2000@…, 12 years ago

I would say not just 'helpful', but 'extremely helpful'. It`s really distracting to read the page to the bottom, and then to scan the page upwards looking for the 'next' buttons. Please, add the prev/next links to the bottom!

comment:5 by Markus Amalthea Magnuson, 11 years ago

Maybe an even better solution would be to make the whole sidebar content sticky, so that the search field, "Contents", "Browse" etc. follow along, always available.

It would need to be the sidebar's bottom (not top) stuck to the window's bottom, otherwise any tall sidebars would get hidden and inaccessible content.

Thoughts on this?

comment:6 by Markus Amalthea Magnuson, 11 years ago

Owner: set to Markus Amalthea Magnuson
Status: newassigned

comment:7 by Markus Amalthea Magnuson, 11 years ago

Another idea (that I actually like better, now that I'm thinking about it) is to have a very visible horizontal bar at the bottom of each page, right between the content box and the "Questions/Feedback" box, containing a previous-link on the left side and a next-link on the right side. It would be the obvious way to go to the next chapter after reading the whole page.

by Markus Amalthea Magnuson, 11 years ago

Mockup of how a previous/next-bar at the bottom of docs pages could look like.

comment:8 by Markus Amalthea Magnuson, 11 years ago

Cc: markus.magnuson@… added

by Markus Amalthea Magnuson, 11 years ago

Mockup of how a previous/next-bar at the bottom of docs pages could look like.

comment:9 by Markus Amalthea Magnuson, 11 years ago

Has patch: set

I've opened a pull request for this change: https://github.com/django/djangoproject.com/pull/51

comment:10 by Markus Amalthea Magnuson, 11 years ago

Anyone wants to have a look at this patch?

by Tim Graham, 11 years ago

Attachment: 16357.png added

comment:11 by Tim Graham, 11 years ago

I like it and have tweaked it slightly, see attached image. (Modified background color & removed "Previous" in favor of guillemets, could also possibly removed "Next" although it seems less awkward since it appears to the right of the next chapter name). Will try to get at least one more opinion and then commit this.

comment:12 by Markus Amalthea Magnuson, 11 years ago

Looks good :) I think "Next" should stay though, for clarity. "Previous" is not as important, as you probably just were on that page. But if someone finds it too asymmetrical to have "Next" and not "Previous" I think finding a way to incorporate the word "Previous" would be better. Just my humble opinion.

comment:13 by Tim Graham <timograham@…>, 11 years ago

Resolution: fixed
Status: assignedclosed

In b109f884e1f63c250d3318a0da0e176faa15edfd/djangoproject.com:

Fixed #16357 - Added navigation buttons to docs footer.

Thanks ncoghlan@ for the suggestion and Markus Magnuson for the patch.

comment:14 by anonymous, 11 years ago

Yay :) When and where will the change go live on the site?

comment:15 by Aymeric Augustin, 11 years ago

It's live.

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