agora/docs/meta/style-guide.md
2022-01-26 16:31:58 +00:00

684 B

Agora docs style guide

This document includes a couple of notes on how Agora documentation should be written and formatted.

Capitalised words

The following words should always be render capitalised:

  • Agora
  • Liqwid
  • LiqwidX
  • Plutus
  • Plutarch

Upper-case terms

The following terms should always be rendered in all capital letters:

  • UTXO
  • EUTXO

Lower-case words

The following words should always be rendered lower-case (unless used at the beginning of a sentence):

  • governance

Avoid

The following practices should be avoided:

  • The use of '&' apart from in proper nouns such as AT&T or commonly-understood abbreviations such as 'R&D'.