From b7cfff0adb87608153d04cb81ddb9504fe165ac4 Mon Sep 17 00:00:00 2001 From: Michael Glass Date: Tue, 26 Mar 2024 19:45:29 +0100 Subject: [PATCH] document updating typedoc --- package.json | 1 + packages/website/README.md | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/package.json b/package.json index d7773607..7467c173 100644 --- a/package.json +++ b/package.json @@ -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" }, diff --git a/packages/website/README.md b/packages/website/README.md index f4951f8f..ddc28c03 100644 --- a/packages/website/README.md +++ b/packages/website/README.md @@ -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.