Skip to content

Commit 5bc6e80

Browse files
committed
Update readme with more details about building and deploying
1 parent 799a431 commit 5bc6e80

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,19 @@ This project is based on [Slate](https://github.com/tripit/slate).
66

77
## Usage ##
88

9-
To generate docs run:
9+
### Updating and building the docs
10+
11+
The docs for the latest version of the REST API (v3) are in `source/includes/wp-api-v3`. Each section of the docs has its own Markdown file. Once you have made changes, you can generate the docs locally with the following:
1012

1113
```bash
1214
./build.sh
1315
```
1416

15-
To deploy generated docs:
17+
After the build script has finished, the generated docs can be found in the `build` directory. Open the `index.html` file in your browser to view the local version of the docs site.
18+
19+
### Deploying the docs
20+
21+
When you merge a PR to the trunk branch of this repository, a workflow runs that will automatically deploy the generated docs to the `gh-pages` branch. However, you can also deploy manually with the following:
1622

1723
```bash
1824
./deploy.sh

0 commit comments

Comments
 (0)