Documentation Standards

This page is intended to standarize documentation and tutorial writing format for RiboKit website.

Landing pages for each package should be placed under repos/ with their name, e.g. ribovis.md.

Text Format

• Markdown (Jekyll / Tutorial)

• Docstring (Python / Sphinx Docs)

Image Format

• Special alignment classes are available.

• Size and Optimization (important)

• Placement path.

Docs Integration

• Jekyll Markdown

For tutorials that are mostly hand-written, we prefer Markdown format.

• Sphinx HTML

For Python docstrings that live inside the code .py files, we prefer Sphinx compilation to HTML.

Branding

• To reference RiboKit, please use the (vertical) official logo https://ribokit.github.io/assets/ribokit_logo.png.

• For RiboKit affiliated sites, please use the official icon https://ribokit.github.io/assets/ribokit_icon.png.

• The horizontal official logo is reserved for the RiboKit main site, as well as formal coverage: https://ribokit.github.io/assets/ribokit_logo_lg.png.