ed5652b0aa
* initial docsite setup * switch from pushd to cd * install and set up solidity-docgen * use the docsite branch next for now * make it clear that env var is a repository * add a clarifying comment about a relative path * change relative to absolute path in docsite script * add docgen script * add first few READMEs for contract documentation * update solidity-docgen * add docsite as dependency and adjust script * update openzeppelin-docsite * update solidity-docgen * remove dummy text * update docgen and docsite * update openzeppelin-docsite * add netlify.toml * udpate tokens guide for 2.2 * add DOCUMENTATION.md * Update docs/learn-about-utilities.md Co-Authored-By: frangio <frangio.1@gmail.com> * fix PaymentSplitter docs wording * update solidity-docgen * add missing ERC20 contracts * update solidity-docgen * trigger deploy with cleared cache * update solidity-docgen * update openzeppelin-docsite * remove travis docs setup * update openzeppelin-docsite * switch to published solidity-docgen
20 lines
1005 B
Markdown
20 lines
1005 B
Markdown
We're building an improved documentation website. It's still in development and
|
|
contributions will be really appreciated.
|
|
|
|
All of the content for the site is in this repository. The guides are in the
|
|
[docs](/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`](https://github.com/OpenZeppelin/solidity-docgen/tree/next) is the
|
|
program that extracts the API Reference from source code.
|
|
|
|
The [`openzeppelin-docsite`](https://github.com/OpenZeppelin/openzeppelin-docsite/tree/next)
|
|
repository hosts the configuration for Docusaurus, the static site generator
|
|
that we use.
|
|
|
|
To run the docsite locally you should run `npm run docsite start` on this
|
|
repository. This will live reload as the guides are edited, but not with
|
|
changes to the source code comments, for that you need to restart the server.
|
|
This should be improved eventually (contributions welcome!).
|