Skip to content

Commit b000764

Browse files
committed
docs: refactor intro page
1 parent b653ada commit b000764

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

Diff for: docs/docs/index.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ Pangraph is currently under heavy development. Bugs and crashes are to be expect
1010

1111
:::
1212

13+
**PanGraph** is a command-line tool for the analysis of bacterial genomes. It compresses multiple genome in a compact **graph representation**, that can be queried to extract information about the evolution of the genomes. It is developed and maintained by [the Neher lab](https://www.biozentrum.unibas.ch/about/administration/administration-a-z/overview/unit/research-group-richard-neher).
14+
15+
## Why Pangraph?
1316

1417
The content and structure of bacterial genomes evolves very rapidly:
1518
Part of the genome can be cut out, duplicated, or inverted.
@@ -26,6 +29,16 @@ The resultant graph represents contiguous intervals of homologous DNA as vertice
2629
Edges of the graph are unordered and only exist if at least one genome was found to connect both vertices in either the forward or reverse strand.
2730
For a more detailed description of the graph structure, see [what is a pangraph](tutorial/t01-building-pangraph.md#what-is-a-pangraph).
2831

29-
This documentation is structures as a [set of tutorials](/category/tutorial) that explain the essential steps to build and manipulate a graph, along with a [reference documentation](/reference) of the available commands. In addition, we provide a python library [pyPanGraph](/category/pypangraph) for analysis of the graph data structure in Python.
32+
## Documentation outline
33+
34+
This documentation contains:
35+
- a [set of tutorials](/category/tutorial) that explain the essential steps to build and manipulate a graph.
36+
- a [reference documentation](/reference) of the available commands.
37+
- in addition, we provide a python library [PyPangraph](/category/pypangraph) for analysis of the graph data structure in Python
38+
39+
40+
:::info[Legacy Pangraph version]
3041

42+
This documentation refers to the latest version of pangraph. Code for the previous `v0` version is available on [the `v0` branch](https://github.com/neherlab/pangraph/tree/v0) of the repository, and the legacy documentation is hosted at https://v0.docs.pangraph.org/.
3143

44+
:::

0 commit comments

Comments
 (0)