state-machine-builder icon indicating copy to clipboard operation
state-machine-builder copied to clipboard

Published 20 hours ago • verified publisher icon adklempner

Setup a documentation build system

Open adklempner opened this issue 7 years ago • 2 comments

I'm leaning towards using the Ethereum Natural Specification Format in the code and generating docs with Digix's Doxity (example here )

Another option is Read the Docs

adklempner avatar Feb 21 '18 19:02 adklempner

According to Aragon, Ethereum's natspec is unsafe and they recommend using their alternative, radspec

and the static site generator for their wiki is powered by MkDocs and Material for MkDocs

adklempner avatar Feb 21 '18 20:02 adklempner

Another options is solidity-docgen used by OpenZeppelin. It integrates with Facebook's Docusaurus, and on first glance I like it a lot. Quick to setup, feature-rich out of the box, and extensible.

adklempner avatar Feb 22 '18 20:02 adklempner