Skip to content

Commit a478fdd

Browse files
committed
Update docs/README.md
1 parent a954c45 commit a478fdd

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# Multisynq Client Docs
22

3-
The docs are deployed at https://docs.multisynq.io/api-reference
3+
These docs are automatically deployed at https://multisynq.github.io/multisynq-client/
44

55
## Building
66

7-
The doc generator uses [JSDoc](https://jsdoc.app) to build the class documentation from structured comments in the source code (in particular `index.js`, `model.js`, `view.js`, `session.js`), as well as tutorials from markdown files in this directory.
7+
To build the docs, use `build-docs.sh` which generates them into the `_site` directory.
8+
This is also what the GitHub action uses to deploy them as GitHub pages.
9+
10+
It uses [JSDoc](https://jsdoc.app) to build the class documentation from structured comments in the source code (in particular `index.js`, `model.js`, `view.js`, `session.js`), as well as tutorials from markdown files in this directory.
811

0 commit comments

Comments
 (0)