Francisco 53f2721e8c Improve documentation about backwards compatibility (#4627) 2 anni fa
..
modules 53f2721e8c Improve documentation about backwards compatibility (#4627) 2 anni fa
templates 02ea01765a Add custom errors to docs (#4480) 2 anni fa
README.md 88a64a802e Update guidelines and project documentation (#3966) 2 anni fa
antora.yml abcec9e4a3 Update docs-utils to support prereleases 2 anni fa
config.js c52625018b Update docs pipeline to solidity-docgen@0.6 (#3707) 3 anni fa

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.