feature request: ToC

[HarikalarKutusu]

It would be very nice if we could have a table of contents on the left column for example.

[Heyhillary]

Hey @HarikalarKutusu

Thanks so much for your suggestion.

I'm currently in the process of acquiring gitbooks, so we can have a better UI including a table of contents.

In the meantime, there is a bullet point list on the top of each page highlighting the three key pages. I can make small improvements to this ahead of the gitbooks transfer.

[HarikalarKutusu]

Thank you Hillary, this resource is a must read as a whole. But I recognized that I had to re-visit some concepts for approval/re-check. That resulted in a "where was it" :) A ToC would be very much usable there.
I'll go ahead and translate this in the following months as defined in the roadmap, if there are no major changes planned...
Best,
Bülent Özden

[Heyhillary]

Hey @HarikalarKutusu

At the moment, there has been a pause with the gitbooks. In the meantime, I have edited the format to a table rather than a bullet point list on the main page. https://common-voice.github.io/community-playbook/

[HarikalarKutusu]

That is indeed much more visible/accessible/readable! Thank you for the effort 👍

[HarikalarKutusu]

@Heyhillary I still would suggest readthedocs.io thou... Mozilla is already using that space. Here is the DeepSpeech documentation:

https://deepspeech.readthedocs.io/en/r0.9/

[Heyhillary]

Thanks for the recommendation. How good is read the docs at hosting localisation ? Initially, I wanted to go for gitbooks as it does have a feature for this.

[HarikalarKutusu]

Well, it is supported of course. Versioning is also supported...
https://docs.readthedocs.io/en/stable/localization.html
https://docs.readthedocs.io/en/stable/versions.html

Here are the localized versions for phpMyAdmin as an example:
https://docs.phpmyadmin.net/en/latest/
https://docs.phpmyadmin.net/de/latest/

The question is how it can be integrated with Pontoon, if you will be using it. Pontoon also has the documentation there, it might be a good idea to contact that group on details.
https://mozilla-pontoon.readthedocs.io/en/latest/