feat: add API documentation generation with TypeDoc (#89)

* feat: add API documentation generation with TypeDoc

- Add TypeDoc configuration for @solana/client package
- Add docs and docs:json scripts for generating API documentation
- Add CI workflow to build and publish docs to GitHub Pages
- Generate markdown and JSON API specs from TypeScript/JSDoc
- Add docs task to turbo.json

Closes #85

* refactor: remove GitHub Pages deployment per review feedback

- Remove workflow_dispatch trigger
- Remove GitHub Pages deployment job
- Keep TypeDoc generation with artifact upload
- Docs will be deployed to solana.com in future PR

* chore: add changeset for TypeDoc API documentation

---------

Co-authored-by: Gui Bibeau <[email protected]>

Author: N-45div

.changeset/add-typedoc-api-docs.md

@@ -0,0 +1,5 @@
+---
+"@solana/client": patch
+---
+
+Add TypeDoc API documentation generation with JSON spec output

.github/workflows/docs.yml

@@ -0,0 +1,49 @@
+name: Generate API Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'packages/client/src/**'
+      - 'packages/client/typedoc.json'
+      - '.github/workflows/docs.yml'
+
+jobs:
+  build-docs:
+    name: Build Documentation
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10.20.0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build packages
+        run: pnpm build
+
+      - name: Generate API documentation
+        run: pnpm --filter @solana/client docs
+
+      - name: Generate JSON API spec
+        run: pnpm --filter @solana/client docs:json
+
+      - name: Upload docs artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: api-docs
+          path: ./packages/client/docs
+          retention-days: 30

packages/client/.gitignore

@@ -1 +1,2 @@
-dist
+dist
+docs

packages/client/package.json

@@ -47,6 +47,8 @@
 		"build": "pnpm compile:js && pnpm compile:typedefs",
 		"compile:js": "tsup --config ../build-scripts/tsup.config.package.ts",
 		"compile:typedefs": "tsc -p ./tsconfig.declarations.json",
+		"docs": "typedoc",
+		"docs:json": "typedoc --json ./docs/api.json",
 		"format": "biome check --write src",
 		"lint": "biome check src",
 		"test:typecheck": "tsc --noEmit -p tsconfig.test.json",
@@ -79,7 +81,9 @@
 		"zustand": "catalog:utils"
 	},
 	"devDependencies": {
-		"@types/node": "catalog:typescript"
+		"@types/node": "catalog:typescript",
+		"typedoc": "^0.28.0",
+		"typedoc-plugin-markdown": "^4.4.0"
 	},
 	"peerDependencies": {
 		"typescript": ">=5.3.3"

packages/client/typedoc.json

@@ -0,0 +1,20 @@
+{
+	"$schema": "https://typedoc.org/schema.json",
+	"entryPoints": ["./src/index.ts"],
+	"out": "./docs",
+	"name": "@solana/client API Documentation",
+	"readme": "./README.md",
+	"plugin": ["typedoc-plugin-markdown"],
+	"outputFileStrategy": "modules",
+	"excludePrivate": true,
+	"excludeProtected": true,
+	"excludeInternal": true,
+	"includeVersion": true,
+	"categorizeByGroup": true,
+	"categoryOrder": ["Client", "Actions", "Hooks", "Types", "*"],
+	"navigationLinks": {
+		"GitHub": "https://github.com/solana-foundation/framework-kit"
+	},
+	"githubPages": true,
+	"hideGenerator": true
+}