Docs

The Celo blockchain client documentation is forked from the go-ethereum documentation, modified as needed to match changes made to the client. These are work in progress and might not always be accurate. Please let us know if there are any issues.

Links:

• geth docs

See also:

• general celo docs

Building the docs locally

With Docker

If you can take advantage of Docker, run:

$ docker-compose up

Navigate to localhost:4000 to browse the docs.

With Ruby

In order to build the docs you need to have ruby installed. We recommend using asdf or rvm. After that you need to install dependencies:

$ bundle install

And run jekyll:

$ bundle exec jekyll server

Navigate to localhost:4000 to browse the docs.