GitBross Home Explore Help
Register Sign In
sol_Bo8des9o
/
openzeppelin-contracts
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: e473bcf859
Branches Tags
openzeppelin-co...
/
docs
Ernesto García 7de6fd4a26 Close `access-control.adoc` code block (#4726) 1 year ago
..
modules 7de6fd4a26 Close `access-control.adoc` code block (#4726) 1 year ago
templates 39400b78ba Ensure constant getters show in docs (#4649) 2 years ago
README.md 88a64a802e Update guidelines and project documentation (#3966) 2 years ago
antora.yml 3e6c86392c Merge release-v5.0 branch (#4665) 2 years ago
config.js c52625018b Update docs pipeline to solidity-docgen@0.6 (#3707) 3 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.