Skip to main content

Documentation

TODO

This article is a work in progress.

In general the documentation available through Aphy Guide includes developer and user documentation, in the English language, in Markdown (through Docusaurus).

General Guidance​

  • line length is at maximum 100 (inclusive, exceptions are permitted)
  • indentation is 4 spaces to an indentation level
  • indentation is to be used for lists (such as this one)
  • (... TBD ...)

Since there is no specific admonition for TODO items, they are noted as illustrated in the following code-block;

:::note[TODO]

your text here

:::

which renders as

TODO

your text here