mirror of openzeppelin-contracts
 
 
 
 
 
openzeppelin-contracts/docs
Ernesto García fd812ee954
Group typographical errors (#5443)
1 month ago
..
modules/ROOT Group typographical errors (#5443) 1 month ago
templates Fix Broken Docs References (#5436) 1 month ago
README.md Update guidelines and project documentation (#3966) 2 years ago
antora.yml Merge release-v5.0 branch (#4665) 1 year 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.