|
@@ -1,5 +1,4 @@
|
|
|
-We're building an improved documentation website. It's still in development and
|
|
|
-contributions will be really appreciated.
|
|
|
+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](/docs) directory, and the API Reference is extracted from comments in
|
|
@@ -9,11 +8,9 @@ repository you should be contributing to.
|
|
|
[`solidity-docgen`](https://github.com/OpenZeppelin/solidity-docgen) is the
|
|
|
program that extracts the API Reference from source code.
|
|
|
|
|
|
-The [`openzeppelin-docsite`](https://github.com/OpenZeppelin/openzeppelin-docsite)
|
|
|
-repository hosts the configuration for Docusaurus, the static site generator
|
|
|
-that we use.
|
|
|
+The [`docs.openzeppelin.com`](https://github.com/OpenZeppelin/docs.openzeppelin.com)
|
|
|
+repository hosts the configuration for the entire site, which includes
|
|
|
+documetation for all of the OpenZeppelin projects.
|
|
|
|
|
|
-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!).
|
|
|
+To run the docs locally you should run `npm run docs start` on this
|
|
|
+repository.
|