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

Documentation Formatting

Josh Quintal edited this page Mar 9, 2021 · 7 revisions
  • Info (Circle I): additional information that may be helpful to the user, but is tangential to the body text. EX: /teams/quickstart (add repo)

  • Warning (Exclamation Triangle): Something may not work as expected if this advice is not heeded. Rule of thumb: If the alert body has "only" "must" in it EX: /teams/getting-started/adding-repositories (config required)

  • Danger (Octagon X): 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 casued an incompatibilty). Something dire will happen if this advice is not heeded (loss of funds). EX: /truffle/getting-started/truffle-with-metamask

Note: Unless we use an extensible markdown format, we'll need to deal with HTML for now in callouts. Just a reminder to use tags like instead of backticks, and tags instead of markdown link formatting.

Clone this wiki locally