Skip to main content

Documentation launched!

Pedro Sader Azevedo
Pedro Sader Azevedo
Developer and Maintainer of parsomics

Documentation for the parsomics project is out!

Implementation​

It was made using Docusaurus an open source static site generator tailored speficially for documentation. Docusaurus, is powered by React, and maintained by Meta. This website is hosted for free on GitLab Pages.

Scope​

This is the complete documentation for the parsomics project. It includes user documentation, for those hoping to use it as it is in their own research, as well as developer documentation, for those hoping to write plugins or contribute to the project.

We included documentation for all parsomics modules, those being:

Main modules​

  • parsomics-core
  • parsomics-api-server
  • parsomics-cli

Plugin modules​

  • parsomics-plugin-clean
  • parsomics-plugin-dbcan
  • parsomics-plugin-interpro
  • parsomics-plugin-proteinfer

We also included developer documentation, for those hoping to write plugins or contribute to parsomics.