[BioRuby] tutorial

Peter Cock p.j.a.cock at googlemail.com
Thu Mar 3 18:14:53 UTC 2011


On Thu, Mar 3, 2011 at 2:47 PM, Toshiaki Katayama <ktym at hgc.jp> wrote:
> Pj,
>
> We just discussed about this on the IRC meeting and people agreed to
> maintain the tutorial on the Wiki rather than in the source code
> because people usually search for docs on the web and we can potentially
> involve more people to improve/update the document. Let's see how it works!
>
> Toshiaki



On Thu, Mar 3, 2011 at 4:17 PM, Chris Fields <cjfields at illinois.edu> wrote:
> All,
>
> We are currently having a discussion related to this re: BioPerl docs and the
> wiki, in relation to our upcoming bioperl release and future directions.  I think
> our current conclusions are relevant here.

I've been reading that thread on the BioPerl list with interest too. My
conclusions from Biopython are similar.

I personally would keep your tutorial in the source code repository,
but try and make a nice HTML version from this which people can
read online and find with search engines. Maybe have two versions
online, the latest release and a nightly build - that's what we do:

http://biopython.org/DIST/docs/tutorial/Tutorial.html
http://biopython.org/DIST/docs/tutorial/Tutorial-dev.html

We need to do more to make the HTML version of Biopython's
API documentation pretty.

Peter




More information about the BioRuby mailing list