mirror of openzeppelin-contracts
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
|
|
We're building an improved documentation website. It's still in development and
|
|
|
|
|
contributions will be really appreciated.
|
|
|
|
|
|
|
|
|
|
All of the content for the site is in this repository. The guides are in the
|
|
|
|
|
[docs](/docs) directory, and the API Reference is extracted from comments in
|
|
|
|
|
the source code. If you want to help improve the content, this is the
|
|
|
|
|
repository you should be contributing to.
|
|
|
|
|
|
|
|
|
|
[`solidity-docgen`](https://github.com/OpenZeppelin/solidity-docgen) is the
|
|
|
|
|
program that extracts the API Reference from source code.
|
|
|
|
|
|
|
|
|
|
The [`openzeppelin-docsite`](https://github.com/OpenZeppelin/openzeppelin-docsite)
|
|
|
|
|
repository hosts the configuration for Docusaurus, the static site generator
|
|
|
|
|
that we use.
|
|
|
|
|
|
|
|
|
|
To run the docsite locally you should run `npm run docsite start` on this
|
|
|
|
|
repository. This will live reload as the guides are edited, but not with
|
|
|
|
|
changes to the source code comments, for that you need to restart the server.
|
|
|
|
|
This should be improved eventually (contributions welcome!).
|
