Matt and company,<br><br>I really like the way the docs are shaping up. The layout looks nice and the disqus comment section is a really nice addition. Is there a way to have an author be notified in some manner when a comment is left on a doc page that they wrote? As the author of a page, I feel like I'm probably unlikely to return to that article very frequently as I'm already quite familiar with the subject matter.<br>
<br>I also second the idea of centralizing all things related to code examples. The cookbook is a nice place, since new users are given a menu of things they can do right on the cookbook page. I feel code examples are more likely to get checked out and used if there's an easy place to be made aware of their existence.<br>
<br>Finally, I think the cookbook could use one more section for extensions recipes, that is using the stuff in yt/extensions. I'm thinking of the halo finders, halo profiler, light cone, EnzoSimulation class, etc. The docs already have a section for extensions, but I think there's a distinction between the extensions docs and extensions recipes. For example, I will write a doc page for the EnzoSimulation class, but also have a page on how to use this with the halo profiler that I think belongs in the cookbook.<br>
<br>Britton<br><br><div class="gmail_quote">On Wed, Sep 30, 2009 at 1:28 PM, Matthew Turk <span dir="ltr"><<a href="mailto:matthewturk@gmail.com">matthewturk@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
Hi guys,<br>
<br>
I've been working in the evenings (and, today, during the day a little<br>
bit...) on the documentation. Britton, Stephen and Jeff have also<br>
chipped in and written a bunch.<br>
<br>
I've uploaded a new build of the docs (which will last until the next<br>
svn commit, at which point it'll be wiped and replaced with whatever<br>
is in SVN currently) to here:<br>
<br>
<a href="http://yt.enzotools.org/doc/" target="_blank">http://yt.enzotools.org/doc/</a><br>
<br>
There are two new features I wanted to mention:<br>
<br>
* The cookbook ( <a href="http://yt.enzotools.org/doc/cookbook/recipes.html" target="_blank">http://yt.enzotools.org/doc/cookbook/recipes.html</a> )<br>
is programmatically generated from the cookbook repository (<br>
<a href="http://hg.enzotools.org/cookbook" target="_blank">http://hg.enzotools.org/cookbook</a> ) and images are generated<br>
automatically as well. All other locations of examples will be wiped<br>
and either left empty or replaced with links or content<br>
programmatically generated from the cookbook repository. It is 100%<br>
my fault, but we have too many scattered, sometimes broken, sometimes<br>
outdated, undocumented examples all over the place. This is my<br>
attempt to fix that.<br>
<br>
* I've added comments to every page in the documentation using<br>
<a href="http://disqus.com" target="_blank">disqus.com</a>. Currently you need an OpenID (gmail supplies this) to<br>
comment. All comments are aggregated on a single page on disqus's<br>
site, or they can be viewed threaded-inline in the docs. This can be<br>
expanded to accept Facebook logins, but I was hesitant on that. What<br>
are y'all's thoughts?<br>
<br>
Also, there are still some major blank spaces in the docs. I'm<br>
working on filling them in, as are other people (mentioned above). If<br>
you'd like to help out, pick out a spot, clone the yt-doc repo, add<br>
text or images or whatever, and I'll give you push privs. (Of course,<br>
as soon as you clone a repo, you already have commit privs. :)<br>
<br>
-Matt<br>
_______________________________________________<br>
Yt-dev mailing list<br>
<a href="mailto:Yt-dev@lists.spacepope.org">Yt-dev@lists.spacepope.org</a><br>
<a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
</blockquote></div><br>