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.
 
 
 
 
 
openzeppelin-contracts/docs
Francisco 84db204a41
Rename rounding modes and complete with fourth (#4455)
2 years ago
..
modules/ROOT Rename rounding modes and complete with fourth (#4455) 2 years ago
templates Show if event parameter is indexed in docs (#3958) 2 years ago
README.md Update guidelines and project documentation (#3966) 2 years ago
antora.yml Update Antora component version 4 years ago
config.js Update docs pipeline to solidity-docgen@0.6 (#3707) 2 years ago

README.md

Documentation is hosted at https://docs.openzeppelin.com/contracts.

All of the content for the site is in this repository. The guides are in the 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 is the program that extracts the API Reference from source code.

The docs.openzeppelin.com repository hosts the configuration for the entire site, which includes documentation for all of the OpenZeppelin projects.

To run the docs locally you should run npm run docs:watch on this repository.