Create issues template for documentation updates or new docs needed about common-voice HOT 2 CLOSED

Amazing timing, this first issue is one of many to start breaking this very problem down.

You're right! The docs are in many places, there's no single source of truth and there are duplicates of the same docs in different places that contradict each other at the moment. I'll be doing some information architecture explorations this week and will be opening more issues in coming weeks to break down the documentation tasks needed to start moving the updated documentation into a single place.

If it's ok, I'll be closing this issue for now as #4445 addressed the template issue, but wanted to write back that I agree and that documentation is one of my big priorities for 2024 as part of working to improve the contributor experience.

from common-voice.

Let me put my ideas for this as a community contribution:

First: May I ask where the documentation is? Currently, the "information" (not a "documentation") is fully scattered:

• Pages & sentences in the WebApp, like the About page, or most important section living deep inside (https://commonvoice.mozilla.org/en/guidelines)
• Github readme's
• Several blog posts
• Several discourse posts
• Some stuff deep in shared Google Drive documents (e.g. PowerPoint)
• The community Playbook https://common-voice.github.io/community-playbook/ nobody knows
• ...

And there is no information on how the whole system works (e.g. how the repos in GitHub are interconnected).

I know it is a huge work to build well-defined documentation, CV is low on resources, but here is an example of it, right from Mozilla:
https://deepspeech.readthedocs.io/en/r0.9/

readthedocs is an ideal place for OpenSource documentation, also supporting GitHub integration (where people can suggest changes there through issues & PR), versioning, and multi-lingual versions, much more and free for OS (https://about.readthedocs.com/pricing/#/community). Of course, there should be directions on the front end for casual users, but it is a pain to keep track of the changes through Pontoon, which is not designed for documentation, but simple localization. For example, there are (say) 3 examples somebody wrote about dinosaurs, but in your language, you should give 5 other special cases, and there is no way to do it. So you cannot even localize it.

To solve these issues, I have been promoting readthedocs, but until some real documentation comes out, we had to create long posts under the sub-Discourse (and point to them), open several Social Media or IM (Telegram) channels, give lectures, record videos, etc.

So, IMHO, let's create documentation first, then try to fix it...

from common-voice.