Style Guide¶

Specification/PIPs¶

• Write in plain english Everyone should be able to comprehend the specification. Try to prevent writing in mathematical notation when it is possible to express it in simple language. MathJax syntax is supported but should only be used as required.
• Document history Changes should be communicated clearly, and documentation about the start and updates of the network be kept. This doesn't apply to changes prior to publishing PIP-1 Whitepaper
• Visualization If something can be better understood with the help of a diagram or pseudocode: go for it. This website supports mermaid.js

Markdown Features¶

Available Features:

• mermaid.js (Diagrams)
• Admonitions (Call-outs)
• footnotes
• pymdownx.details (Collapsible elements)
• pymdownx.tabbed (Tabs)
• pymdownx.superfences (Advanced nesting)
• pymdownx.arithmatex (LaTeX)