Introduction to Smart Docs

Let's discover Smart Docs in less than 2 minutes.

Getting Started​

Get started by uploading your ABI with the button below.

Or just use Smart Docs with an already loaded ABI interface from local storage.

1. Uploading a new ABI JSON file​

Generate your smart contract documentation by uploading your ABI JSON file:

2. Using an already loaded ABI interface​

View the documentation status in the bottom right corner.

Current docs status​

View your contract to get some basic information about your smart contract.

Why this project exists?​

The transfer from backend to frontend can be very smooth when working with Web 2.0 technologies like REST or GraphQL API's. Many tools exist to make your life easier and provide beautiful documentation for your frontend developers.

In the Web 3.0 space things are different. To visualize the available properties and functions in a smart contract, you need to have backend tools in order to get a good understanding of how a smart contract can be used. With Smart Docs you get a beautiful documentation page like you get with Swagger for example.

Beta project​