rename docsite script to docs and update docs setup description
This commit is contained in:
@ -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.
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
[build]
|
||||
command = "npm run docsite build"
|
||||
command = "npm run docs build"
|
||||
publish = "openzeppelin-docs/build/site"
|
||||
|
||||
@ -13,7 +13,7 @@
|
||||
"compile": "scripts/compile.sh",
|
||||
"console": "truffle console",
|
||||
"coverage": "scripts/coverage.sh",
|
||||
"docsite": "scripts/docsite.sh",
|
||||
"docs": "scripts/docs.sh",
|
||||
"prepare-docs": "scripts/prepare-docs.sh",
|
||||
"lint": "npm run lint:js && npm run lint:sol",
|
||||
"lint:fix": "npm run lint:js:fix",
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
if [ "$1" != "build" -a "$1" != "start" ];then
|
||||
echo "usage: npm run docsite (build|start)" >&2
|
||||
echo "usage: npm run docs (build|start)" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
Reference in New Issue
Block a user