RPP 02 - Ethdoc Plugin

[defiboy]

Ethdoc Remix Plugin

Background

The current Remix Ethdoc Plugin is located at:

https://github.com/Machinalabs/remix-ethdoc

And hosted in surge http://machinalabs-remix-ethdoc-plugin.surge.sh/.

At the moment the Ethdoc plugin generates .md files with content that is generated from smart contracts.

There are some limitations with the .md files because at the moment Remix doesn't allow the preview of the generated documentation.

Proposal

• Migrate existing codebase to a React based application.

• Change .md files generation engine for a HTML based engine. So that users can preview and publish to a hosting provider (IPFS for the moment).

• Modify the UI interface.

  • Allow users to generate and preview the documentation within Remix IDE.

  • Allow documentation publishing via 1 click button.

Design

Preview

Once a contract is clicked, we should generate and preview the documentation in the main panel.

Remix Requirements

Remix should allow plugins to be positioned in the side panel and render content on the main panel.

Resources

https://solidity.readthedocs.io/en/develop/natspec-format.html

https://github.com/OpenZeppelin/solidity-docgen

https://github.com/aragon/radspec

[yann300]

this will be using OpenZeppelin doc gen?

[defiboy]

I still need to decide because for what I see OpenZeppelin doc works in node.js environments and there are some dependencies that I'm also not sure if are fully supported in the browser. But the idea is to do a PoC and narrow down the options.

So at the end, I can either take doc generation engine from OpenZepellin doc and adapt to a Remix plugin but use a different template engine, etc.