github-actions[bot] 69c8def5f2 Release v5.1.0 (#5265) 11 月之前
..
modules 1bcd1c65db Split StorageSlot into TransientSlot (#5239) 11 月之前
templates 036c3cbef2 Replace custom errors with native panic codes in DoubleEndedQueue (#4872) 1 年之前
README.md 88a64a802e Update guidelines and project documentation (#3966) 2 年之前
antora.yml 69c8def5f2 Release v5.1.0 (#5265) 11 月之前
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.