#68 Update UI bundle for local build and remove tocs from documents
Merged by oturpe. Opened by ankursinha.
fedora-docs/ ankursinha/package-maintainer-docs feat/drop-tocs  into  main

Download 68.patch

The new UI bundle includes a toc in the right hand side bar already, so we can drop the explicit tocs in the docs themselves. Makes the docs shorter, and shows the text of the page straightaway now.

In general I agree.
Since we want to have the toc on all pages,
it is better to use the automatic option.
And there is no point in having two of them.

But did you consider mobile users?
The sidebar is not visible when viewport is narrow.
I have never before attempted to use these docs on mobile,
but I did now, to see how it works.
Without any toc at all,
the longer articles would become quite annoying to use.

Also the left hand side component navigation disappears,
but for it, an icon appears instead.
For the table of contents, there is no icon
— perhaps this is worth reporting on the ui bundle upstream?
If they agree that missing toc on mobile is a problem,
perhaps we could wait until the problem is fixed there
and only merge this update after that?

Sure---I've reported this: https://pagure.io/fedora-docs/fedora-docs-ui/issue/57

I think the userdocs are perhaps more important for mobile platforms, but I wouldn't expect too many of us to read developer docs on mobile phones. e.g., I usually refer to these when I'm working on a package, so I'm at a workstation.

Turns out the contents in the right hand bar do show in the mobile view, but not if an explicit TOC is added. So, if you build this PR locally and then check in FF, you see it:

https://pagure.io/fedora-docs/fedora-docs-ui/issue/raw/files/6002a86b6f8ec262cc2e8343a85ab1b39d4e660fe38612beea38b3174445043a-Screen_Shot_2022-03-16_at_17.51.33.png

Pull-Request has been merged by oturpe

Great! Thank you for the contribution, merging this now.

Metadata