Skip to content

Commit 29bda58

Browse files
committed
feat(sdk): set up docs tasks on main
1 parent f75e6a6 commit 29bda58

File tree

5 files changed

+98
-2
lines changed

5 files changed

+98
-2
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ coverage
55
.cache
66
tsconfig.tsbuildinfo
77
.DS_Store
8+
docs

package.json

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
"lefthook": "^1.6.15",
3333
"prettier": "^3.2.5",
3434
"turbo": "^2.0.0",
35+
"typedoc": "^0.26.4",
3536
"typescript": "^5.3.3",
3637
"vite": "^5.2.13",
3738
"vitest": "^1.6.0"

packages/sdk/package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
"bench:ci": "CI=true vitest bench",
3535
"clean": "rm -rf dist",
3636
"test": "vitest dev",
37-
"test:ci": "CI=true vitest --coverage"
37+
"test:ci": "CI=true vitest --coverage",
38+
"typedoc": "npx typedoc"
3839
},
3940
"devDependencies": {
4041
"@boostxyz/evm": "workspace:*"

packages/sdk/typedoc.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
// Comments are supported, like tsconfig.json
3+
"entryPoints": ["./src/index.ts"],
4+
"exclude": ["./test", "./src/**/*.test.ts"],
5+
"out": "docs"
6+
}

pnpm-lock.yaml

+88-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)