Re: Reigniting our docs effort

The idea to renew the documentation is always nice.

Which one are you referring to? Our README? Our User Manual?

Why do you think, FAQ is redundant? I do not remember its content being
covered anywhere else.


Eugene

On 7 August 2018 at 22:28, Matan Bareket <[email protected]> wrote:

> Team,
>
> I want to try and reignite our documentation effort which will eventually
> consolidate all of the disparate docs we have (doxygen, site pages,
> quickstart, wiki, readme) into one central location.
>
> In order to do so, i'd like to do the following:
>
>    1. Create a new repo called scummvm-docs
>    2. Convert existing docs into reStructredText - Initial pass won't
>    make much sense but it will be a good place to work off.
>    3. Eliminate redundant information - For example the FAQ on the
>    website. The wiki will be focused on more developer related items.
>    4. Use readthedocs to host & manage docs
>
> A few notes: https://readthedocs.org/ is a free service that takes care
> of the headaches of managing by automatically synchronizing with the docs
> repo. It also uses Sphinx to create the documentation, it also supports
> multiple languages so we can hook it up to weblate for translators to work
> off.
>
> There are a few doxygen to sphinx parsers, but it's more of a phase 2.
>
> Hopefully getting everything we have now into one central location that
> can be easily updated via git will encourage active work on our docs.
>
> One caveat to readthedocs is that they place a single ethical ad on the
> sidebar. We can potentially host everything ourselves if it's a big issue.
>
> Some sample sites on readthedocs:
> https://docs.phpmyadmin.net/en/latest/
> http://docs.godotengine.org/en/3.0/
>
>
>
> _______________________________________________
> Scummvm-devel mailing list
> [email protected]
> http://lists.scummvm.org/listinfo/scummvm-devel
>
>

_______________________________________________
Scummvm-devel mailing list
[email protected]
http://lists.scummvm.org/listinfo/scummvm-devel