Skip to content

Commit 48098b3

Browse files
committed
Create documentation page
1 parent 4d8caa0 commit 48098b3

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

_wiki/documentation.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Documentation
3+
permalink: wiki/Documentation
4+
menu: main
5+
---
6+
7+
There are three main sources of documentation for BioJava: the tutorial, the cookbook and the Javadoc APIs. The most appropiate one will depend on you needs. As a rule of thumb, the tutorial is best suited for beginners looking for an introduction to the general structure and features of the library, while the cookbook is intended for more advanced users looking for a specific use case. Another useful guide are the demos in each BioJava module.
8+
9+
The BioJava tutorial
10+
--------------------
11+
12+
The goal of the tutorial is to give an educational introduction into some of the features that are provided by BioJava and each of its modules.
13+
14+
The tutorial is being hosted on GitHub at [https://github.com/biojava/biojava-tutorial](https://github.com/biojava/biojava-tutorial).
15+
16+
The BioJava CookBook
17+
--------------------
18+
19+
The CookBook is a collection of common bioinformatics problems solved using BioJava explained step by step. The CookBook was included in the mediawiki pages and it has been migrated to the current website.
20+
You can access it [here](BioJava%3ACookBook4.0).
21+
22+
The Javadoc APIs
23+
----------------
24+
25+
And finally the collection of Javadoc APIs. The link will take you to the generated HTML version of the Javadoc. You can choose from the following versions:
26+
27+
- [Javadoc API for BioJava 5.0.0]({{site.baseurl}}/docs/api5.0.0/index.html)
28+
- [Javadoc API for BioJava 4.2.9]({{site.baseurl}}/docs/api4.2.9/index.html)
29+
- [Javadoc API for BioJava 4.2.1]({{site.baseurl}}/docs/api4.2.1/index.html)
30+
- [Javadoc API for BioJava 4.2.0]({{site.baseurl}}/docs/api4.2.0/index.html)
31+
- [Javadoc API for BioJava legacy 1.9.1]({{site.baseurl}}/docs/api1.9.1/index.html)

0 commit comments

Comments
 (0)