Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Documentation Formatting

Jump to bottom
Josh Quintal edited this page Mar 9, 2021 · 7 revisions

Callouts

Callouts point out helpful information to readers. There are 3 types:

  • Info (fa-info-circle): additional information that may be helpful to the user, but is tangential to the body text.

    Example: Truffle Teams - Quickstart

  • Warning (fa-exclamation-triangle): Something may not work as expected if this advice is not heeded. Rule of thumb: If the callout contains "only" or "must".

    Example: Ganache - Unlinking a Corda Project

  • Danger (fa-times-octagon): Something is broken, we're aware of it, and the reader should avoid it (could be a bug in our software or an external bug that has caused an incompatibility). Something dire will happen if this advice is not heeded (loss of funds).

    Example: Truffle - Choosing an Ethereum Client

Reminder: Until we use an extensible markdown format, we'll need to use HTML in callouts. Because of this, you'll have to use tags like <code> instead of backticks, and <a> tags instead of markdown link formatting.

Clone this wiki locally