Skip to content

Commit

Permalink
Merge pull request #34 from nlxai/how-to-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelglass authored Mar 26, 2024
2 parents 9ea1ca1 + b7cfff0 commit a5c3f8f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"build": "lerna run build",
"postinstall": "npm run build",
"publish": "rm -f package-lock.json && rm -f packages/*/package-lock.json && lerna publish --no-private",
"publish-docs": "lerna run publish-docs",
"test": "lerna run test",
"watch": "lerna watch -- lerna run build --since"
},
Expand Down
5 changes: 5 additions & 0 deletions packages/website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,8 @@ This is the source of https://developers.nlx.ai/, the documentation website for
## Build

* `npm run build`


## Updating docs

API docs are generated automatically using [TypeDoc](https://typedoc.org/). To update the docs, run `npm run publish-docs` from the monorepo root and commit the changes. Feel free to trim the outputted md files for better formatting.

0 comments on commit a5c3f8f

Please sign in to comment.