Eric Lau 6a0cfcedf0 Update "Using with Upgrades" page for 5.0 (#4659) 2 年之前
..
modules 6a0cfcedf0 Update "Using with Upgrades" page for 5.0 (#4659) 2 年之前
templates e49fcbeb56 Ensure constant getters show in docs (#4649) 2 年之前
README.md 88a64a802e Update guidelines and project documentation (#3966) 2 年之前
antora.yml abcec9e4a3 Update docs-utils to support prereleases 2 年之前
config.js c52625018b Update docs pipeline to solidity-docgen@0.6 (#3707) 3 年之前

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.