<div dir="ltr"><div><div>I think Markdown can do the work. It is simple and a good number of JS devs are using it (or know it). Jsonix repo use Wiki pages with Markdown, but maybe will be better use Github-pages with Markdown.</div></div><div><br></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Mon, Mar 16, 2015 at 7:47 AM, Tom Kralidis <span dir="ltr"><<a href="mailto:tomkralidis@gmail.com" target="_blank">tomkralidis@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><br>
<br>
On Mon, 16 Mar 2015, Daniel Nüst wrote:<br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Date: Mon, 16 Mar 2015 11:18:21 +0100<br>
From: Daniel Nüst <<a href="mailto:d.nuest@52north.org" target="_blank">d.nuest@52north.org</a>><br>
To: <a href="mailto:owsjs@lists.osgeo.org" target="_blank">owsjs@lists.osgeo.org</a><br>
Subject: [ows.js] Documentation framework<span class=""><br>
<br>
Hi guys!<br>
<br>
I started working on a <a href="http://contribute.md" target="_blank">contribute.md</a> (see [1]) and was wondering what your opinions are on a suitable documentation framework. At this point I don't see myself contributing large amounts of code but I could help with documentation etc.<br>
<br>
</span></blockquote>
<br>
This would be awesome!<span class=""><br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
So my question is how we will create documentation, particularly user documentation and examples.<br>
<br>
I like readthedocs [2] (uses Sphinx and would do the hosting for us), but the more experienced JS devs might have a better understanding what works well. Maybe this lists/blog posts [3] gives us a starting points for discussion.<br>
<br>
Will we use inline documentation and/or different systems (inline for API doc, GitHub wiki for examples)?<br>
<br>
Please share your experiences!<br>
IMHO we should pick something that the current developers are comfortable with.<br>
<br>
</blockquote>
<br></span>
Using sphinx with readthedocs for documentation has worked for me in<br>
the past.  Are there alternatives which are friendly for JavaScript<br>
devs?<br>
<br>
For examples we may or may not require a deployment given accessing<br>
content via JS on other servers.<span class=""><br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
Somehow related: How about a landing page for the project base on GitHub-pages?<br>
<br>
</blockquote>
<br></span>
+1.  I'll set this up once we have a doc setup.<div class="HOEnZb"><div class="h5"><br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
Best regards,<br>
Daniel<br>
<br>
[1] <a href="https://github.com/OSGeo/ows.js/issues/2" target="_blank">https://github.com/OSGeo/ows.<u></u>js/issues/2</a><br>
[2] <a href="https://readthedocs.org/" target="_blank">https://readthedocs.org/</a><br>
[3] <a href="http://www.lsauer.com/2013/05/javascript-documentation-generator.html" target="_blank">http://www.lsauer.com/2013/05/<u></u>javascript-documentation-<u></u>generator.html</a> and <a href="http://dailyjs.com/2011/01/13/framework-part-46/" target="_blank">http://dailyjs.com/2011/01/13/<u></u>framework-part-46/</a> and <a href="http://blog.fusioncharts.com/2013/12/jsdoc-vs-yuidoc-vs-doxx-vs-docco-choosing-a-javascript-documentation-generator/" target="_blank">http://blog.fusioncharts.com/<u></u>2013/12/jsdoc-vs-yuidoc-vs-<u></u>doxx-vs-docco-choosing-a-<u></u>javascript-documentation-<u></u>generator/</a><br>
<br>
-- <br>
Daniel Nüst<br>
52°North Initiative for Geospatial Open Source Software GmbH<br>
Martin-Luther-King-Weg 24<br>
48155 Münster, Germany<br>
E-Mail: <a href="mailto:d.nuest@52north.org" target="_blank">d.nuest@52north.org</a><br>
Fon: <a href="tel:%2B49-%280%29-251%E2%80%93396371-36" value="+4925139637136" target="_blank">+49-(0)-251–396371-36</a><br>
Fax: <a href="tel:%2B49-%280%29-251%E2%80%93396371-11" value="+4925139637111" target="_blank">+49-(0)-251–396371-11</a><br>
<br>
<a href="http://52north.org/" target="_blank">http://52north.org/</a><br>
Twitter: @FiveTwoN<br>
<br>
General Managers: Dr. Albert Remke, Dr. Andreas Wytzisk<br>
Local Court Muenster HRB 10849<br>
______________________________<u></u>_________________<br>
owsjs mailing list<br>
<a href="mailto:owsjs@lists.osgeo.org" target="_blank">owsjs@lists.osgeo.org</a><br>
<a href="http://lists.osgeo.org/cgi-bin/mailman/listinfo/owsjs" target="_blank">http://lists.osgeo.org/cgi-<u></u>bin/mailman/listinfo/owsjs</a><br>
<br>
</blockquote>
______________________________<u></u>_________________<br>
owsjs mailing list<br>
<a href="mailto:owsjs@lists.osgeo.org" target="_blank">owsjs@lists.osgeo.org</a><br>
<a href="http://lists.osgeo.org/cgi-bin/mailman/listinfo/owsjs" target="_blank">http://lists.osgeo.org/cgi-<u></u>bin/mailman/listinfo/owsjs</a><br>
</div></div></blockquote></div><br></div>