Opened 3 years ago

Closed 3 years ago

#33364 closed New feature (invalid)

Improve Documentation by having list of topics fixed on the left and table of contents on the right

Reported by: Lokesh Sanapalli Owned by: nobody
Component: Documentation Version: dev
Severity: Normal Keywords: documentation, optimization
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Lokesh Sanapalli)

Hey all,

I am using Django for a long time. One thing I feel we can improve is that the reading experience of the documentation. Especially when the page is very long. Two problems I can see

  1. There is a table of contents on the right side, but it is not fixed and it doesn't follow the page. So, when the page is very long, keeping track of the topic is very very hard and it takes a mental leap to go back and navigate.
  2. Also, on any page, you can only see only the previous topic and the next topic, not the whole content.

Below are some of the example documentation

Please let me know if there's already a plan for it. If not, please someone guide me on implementing this.

Change History (2)

comment:1 by Lokesh Sanapalli, 3 years ago

Description: modified (diff)

comment:2 by Mariusz Felisiak, 3 years ago

Resolution: invalid
Status: newclosed

Thanks for the ticket, however this should be reported and discussed in the issue tracker.

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