<div dir="ltr">Okay.<div><br></div><div>I have a couple of questions then:</div><div> </div><div> 1. Will it be possible to export the result into an 80-columns text format, so we could ship it as part of the distribution?</div><div> 2. Would it be possible to have fixed reference URLs for the relevant FAQ items?</div><div><br></div><div><br></div><div>Eugene</div></div><div class="gmail_extra"><br><div class="gmail_quote">On 9 August 2018 at 12:26, Matan Bareket <span dir="ltr"><<a href="mailto:mataniko@gmail.com" target="_blank">mataniko@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div>I'm proposing to start with converting both the User Manual and the README to the new format as sort of a v.1 and then start editing everything together into something more cohesive.</div><div><br></div><div>Some of the FAQ is redundant today, for example the introduction section, supported games section, parts of running games - all of these are covered either in the manual or the README. Other parts are not.<br></div><div><br></div><div>Eventually the new docs hub should cover most of the FAQ and migrate the rest.<br> </div></div><div class="HOEnZb"><div class="h5"><br><div class="gmail_quote"><div dir="ltr">On Thu, Aug 9, 2018 at 2:11 AM Eugene Sandulenko <<a href="mailto:sev@scummvm.org" target="_blank">sev@scummvm.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">The idea to renew the documentation is always nice.<div><br></div><div>Which one are you referring to? Our README? Our User Manual?</div><div><br></div><div>Why do you think, FAQ is redundant? I do not remember its content being covered anywhere else.</div><div><br></div><div><br></div><div>Eugene</div><div class="gmail_extra"><br><div class="gmail_quote">On 7 August 2018 at 22:28, Matan Bareket <span dir="ltr"><<a href="mailto:mataniko@gmail.com" target="_blank">mataniko@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div>Team,</div><div><br></div><div>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.</div><div><br></div><div>In order to do so, i'd like to do the following:</div><div><ol><li>Create a new repo called scummvm-docs</li><li>Convert existing docs into reStructredText - Initial pass won't make much sense but it will be a good place to work off.</li><li>Eliminate redundant information - For example the FAQ on the website. The wiki will be focused on more developer related items.<br></li><li>Use readthedocs to host & manage docs</li></ol><div>A few notes: <a href="https://readthedocs.org/" target="_blank">https://readthedocs.org/</a> 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.</div><div><br></div><div>There are a few doxygen to sphinx parsers, but it's more of a phase 2.</div><div><br></div><div>Hopefully getting everything we have now into one central location that can be easily updated via git will encourage active work on our docs.</div><div><br></div><div>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.</div><div><br></div><div>Some sample sites on readthedocs:</div><div><a href="https://docs.phpmyadmin.net/en/latest/" target="_blank">https://docs.phpmyadmin.net/<wbr>en/latest/</a></div><div><a href="http://docs.godotengine.org/en/3.0/" target="_blank">http://docs.godotengine.org/<wbr>en/3.0/</a><br></div><div><br></div><div><br></div></div></div>
<br>______________________________<wbr>_________________<br>
Scummvm-devel mailing list<br>
<a href="mailto:Scummvm-devel@lists.scummvm.org" target="_blank">Scummvm-devel@lists.scummvm.<wbr>org</a><br>
<a href="http://lists.scummvm.org/listinfo/scummvm-devel" rel="noreferrer" target="_blank">http://lists.scummvm.org/<wbr>listinfo/scummvm-devel</a><br>
<br></blockquote></div><br></div></div>
</blockquote></div>
</div></div></blockquote></div><br></div>