From 18d7e24a2c156285f032044e06eba36610b25e1b Mon Sep 17 00:00:00 2001 From: Francisco Giordano Date: Fri, 16 Aug 2019 20:03:49 +0200 Subject: [PATCH] rename docsite script to docs and update docs setup description --- DOCUMENTATION.md | 15 ++++++--------- netlify.toml | 2 +- package.json | 2 +- scripts/{docsite.sh => docs.sh} | 2 +- 4 files changed, 9 insertions(+), 12 deletions(-) rename scripts/{docsite.sh => docs.sh} (93%) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index a9545971e..72f6199f3 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -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. diff --git a/netlify.toml b/netlify.toml index 44f6723b9..71dad4c55 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,3 +1,3 @@ [build] -command = "npm run docsite build" +command = "npm run docs build" publish = "openzeppelin-docs/build/site" diff --git a/package.json b/package.json index a49a866e1..2f7313068 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/scripts/docsite.sh b/scripts/docs.sh similarity index 93% rename from scripts/docsite.sh rename to scripts/docs.sh index bc2fbf1f7..b1bcf0d38 100755 --- a/scripts/docsite.sh +++ b/scripts/docs.sh @@ -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