Skip to content

Commit 23c4a48

Browse files
committed
docs/Add API docs generator and update scripts
Introduces a script to generate JSON-RPC API documentation from the TypeScript SDK, adds new npm scripts for API docs generation, and updates .gitignore to exclude generated API reference files.
1 parent dd3458c commit 23c4a48

File tree

3 files changed

+412
-1
lines changed

3 files changed

+412
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ tests/src/common/fixtures/lookup_tables.json
2929
# Docs
3030
sdks/ts/docs-html/
3131
sdks/ts/docs-md/
32+
docs/api-reference-generated/
3233

3334
# AI
3435
.claude/

sdks/ts/package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@
2727
"docs": "typedoc --readme none && node scripts/add-toc.js",
2828
"docs:html": "typedoc --options typedoc.html.json",
2929
"docs:watch": "typedoc --watch",
30-
"docs:serve": "pnpm run docs:html && npx serve docs-html"
30+
"docs:serve": "pnpm run docs:html && npx serve docs-html",
31+
"docs:api": "node scripts/generate-api-docs.js",
32+
"docs:all": "pnpm run docs && pnpm run docs:api"
3133
},
3234
"files": [
3335
"dist"

0 commit comments

Comments
 (0)