diff --git a/README.md b/README.md index a1913e3..24eeb88 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# [Speckle](http://spekcle.works) OpenApi Documentation +# [Speckle](https://speckle.works) OpenApi Documentation [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1319026.svg)](https://doi.org/10.5281/zenodo.1319026) @@ -8,12 +8,16 @@ Open the `SpeckleV1OpenApiSpecs.yaml` file in the [OpenApi editor](https://editor.swagger.io//#/). You can then edit at your own ease, and suggest changes, etc. -# Build the docs +# Local build -To save time, please also follow these quick steps to build the documentation: +To build the docs locally, please follow these quick steps: 1. `npm install` -2. `npm run build-shins` - this will generate the docs (which are published via github from the `docs` folder. -3. Commit and do a PR. +2. `(cd shins && npm install)` +3. `npm run build-shins` - this will generate the docs + +# Commit + +The html rendering is produced by Travis. If you're pushing to the `master` branch, Travis will try to deploy the contents of the docs directory to the `gh-pages` branch. That's it!