[DOCS] Make Download Section Easier To Find

[franzihei]

Problem

People are not aware that there is the option to download the Solidity docs and we've had several requests about this recently. The download option is so hidden in the flyout menu (some need to scroll to see it), since the list of versions has grown quite long.

Example:

Solution

Place the download options at a more obvious / easier visible place in the menu.

Related Discussion

https://forum.soliditylang.org/t/please-can-i-get-the-documentation-in-downloadable-form/615/7

[Shorpee]

Would moving the downloads tab to the top be a good solution or is there something else you have in mind for this?

[franzihei]

Moving them above the versions is a good idea in my opinion. I didn't have anything specific in mind for it yet and I think that's a good and easy solution for now!

[chriseth]

I'm actually not sure if we have full control about the layout of this "popup". We could start by mentioning the download options on the first pages of the documentation, maybe close to the "translations" section.

[cameel]

Fortunately we do. The order is defined by our template so we can just swap these two items to get downloads on top.

[cameel]

In that template we can even easily put a link above the fold so that it's always visible.

A link in the footer is also a possibility.

[nishant-sachdeva]

@franzihei @cameel @chriseth Is it fine to move the download section ahead of the versions section?

If needed, we can also add it to the Resources Section.

If that is fine, then I am ready to send in a PR to that effect

[franzihei]

Yes sounds great please do.

Additionally to moving the download section over the versions section in the flyout menu, could you add a green "hint" section on the index page, between Ideas for improving Solidity or this documentation are always welcome, read our contributors guide for more details. and Getting Started which says something like:

Hint:
You can download this documentation as PDF, HTML or Epub by clicking on the versions flyout menu in the left bottom corner and selecting the preferred download format.

[cameel]

#12277 has just been deployed to RTD (https://docs.soliditylang.org/en/latest/) but looks like it didn't work correctly.

The RTD logo is gone but there's no PDF link in its place:

Downloads and versions are also still in the old order when you open the popup.

When reviewing I only checked the rendered version from CircleCI and noticed that the link was missing there but in that version the JS that opens the menu does not load so I thought it was just an artifact of that. Apparently not :)

@nishant-sachdeva Have you tried rendering the docs locally? Or did it work locally and it's only broken at RTD?

[nishant-sachdeva]

Yes, I assumed that javaScript issue was at work as well.

But the download section was above the version section in my local rendering.

Will investigate this Asap