Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#16933 closed Cleanup/optimization (fixed)

Make it more obvious on screen which version of the doc is being viewed

Reported by: julien Owned by: nobody
Component: * Version: 1.3
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: yes


This came up as the same (invalid) doc bug in the tutorial was reported multiple times within just a few days (#16868, #16890 and #16932), likely because the reporters were looking at the wrong version of the documentation. This doesn't only affect newbies as I've also recently heard from an experienced Django developer that he got excited about a documented feature that he later realised he couldn't use in his environment because that feature hadn't been released yet (he was looking at the DEV doc without knowing). It's quite easy to get bitten by this, especially if you use Google to search the doc.

One possible fix would be to add a nifty little block "DEV version" or "1.3 version" with a fixed position (e.g. stuck to the top of the viewport) as you scroll down the page.

I'm choosing the component " Web site" (and not "Documentation") since this is where the change needs to happen, i.e. in:

Change History (3)

comment:1 Changed 4 years ago by julien

And #16954 was another one...

comment:2 Changed 4 years ago by julien

  • Resolution set to fixed
  • Status changed from new to closed

This is now fixed. Check out the little green box in the bottom right corner:

comment:3 Changed 4 years ago by RobBednark

Although this was implemented, I didn't see it and spent 4 hours figuring out why the tutorial code wasn't working for me (I was using Django 1.3.1 but looking at the tutorial for the dev version). In case someone else comes across this, here's a screenshot showing the little green box with the version, which you can click on to select a different version:

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