Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document updating typedoc #34

Merged
merged 1 commit into from
Mar 26, 2024
Merged

document updating typedoc #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
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
View file
Open in desktop
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.