[Django] #33364: Improve Documentation by having list of topics fixed on the left and table of contents on the right

[Django]

#33364: Improve Documentation by having list of topics fixed on the left and table
of contents on the right
-------------------------------------+-------------------------------------
Reporter: Lokesh | Owner: nobody
Sanapalli |
Type: New | Status: new
feature |
Component: | Version: dev
Documentation | Keywords: documentation,
Severity: Normal | optimization
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
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

https://getbootstrap.com/docs/5.1/getting-started/introduction/

https://vuejs.org/v2/guide/

https://docs.spring.io/spring-
framework/docs/current/reference/html/core.html

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

--
Ticket URL: <https://code.djangoproject.com/ticket/33364>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#33364: Improve Documentation by having list of topics fixed on the left and table
of contents on the right
-------------------------------------+-------------------------------------

Reporter: Lokesh Sanapalli | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: documentation, | Triage Stage:
optimization | Unreviewed
Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Description changed by Lokesh Sanapalli:

Old description:

> 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
>
> https://getbootstrap.com/docs/5.1/getting-started/introduction/
>
> https://vuejs.org/v2/guide/
>
> https://docs.spring.io/spring-
> framework/docs/current/reference/html/core.html
>
> Please let me know if there's already a plan for it. If not, please
> someone guide me on implementing this.

New description:

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

https://getbootstrap.com/docs/5.1/getting-started/introduction/

https://vuejs.org/v2/guide/

https://docs.spring.io/spring-
framework/docs/current/reference/html/core.html

https://tailwindcss.com/docs/configuration

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

--

--
Ticket URL: <https://code.djangoproject.com/ticket/33364#comment:1>

[Django]

#33364: Improve Documentation by having list of topics fixed on the left and table
of contents on the right
-------------------------------------+-------------------------------------

Reporter: Lokesh Sanapalli | Owner: nobody

Type: New feature | Status: closed
Component: Documentation | Version: dev
Severity: Normal | Resolution: invalid

Keywords: documentation, | Triage Stage:
optimization | Unreviewed

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Mariusz Felisiak):

* status: new => closed
* resolution: => invalid

Comment:

Thanks for the ticket, however this should be reported and discussed in
the [https://github.com/django/djangoproject.com/issues djangoproject.com
issue tracker].

--
Ticket URL: <https://code.djangoproject.com/ticket/33364#comment:2>