Skip to content

Commit 1aa93cd

Browse files
committed
🤖 refactor: replace API Extractor with TypeDoc
Consolidates API documentation from 92 files to 1 file (1055 lines). Changes: - Removed @microsoft/api-extractor and @microsoft/api-documenter - Added typedoc and typedoc-plugin-markdown - Replaced api-extractor.json with typedoc.json - Deleted tsconfig.api-extractor.json (no longer needed) - Generated single docs/api/index.md instead of 92 separate files - Updated 'make docs-api' and 'bun run docs:api' commands - Updated .gitignore (removed temp/, etc/, added .typedoc/) Benefits: - Easier to navigate (single page with table of contents) - Less maintenance burden (1 file vs 92) - Better user experience (cmd+f to find anything) - Cleaner docs/ directory structure Generated with cmux
1 parent 9574af2 commit 1aa93cd

File tree

99 files changed

+1108
-4374
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+1108
-4374
lines changed

.gitignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,5 @@ terminal-bench-results/
110110
nodemon.json
111111
test_hot_reload.sh
112112

113-
# API Extractor
114-
temp/
115-
etc/
113+
# TypeDoc
114+
.typedoc/

Makefile

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -279,10 +279,9 @@ docs-watch: ## Watch and rebuild documentation
279279

280280
docs-api: ## Generate extension API reference documentation
281281
@echo "$(BLUE)Generating extension API documentation...$(RESET)"
282-
@bun x tsc -p tsconfig.api-extractor.json
283-
@bun x api-extractor run --local
284-
@bun x api-documenter markdown --input-folder temp/api --output-folder docs/api
285-
@echo "$(GREEN)✓ API documentation generated in docs/api/$(RESET)"
282+
@bun x typedoc
283+
@mv docs/api/README.md docs/api/index.md 2>/dev/null || true
284+
@echo "$(GREEN)✓ API documentation generated in docs/api/index.md$(RESET)"
286285

287286
## Storybook
288287
storybook: node_modules/.installed ## Start Storybook development server

api-extractor.json

Lines changed: 0 additions & 455 deletions
This file was deleted.

bun.lock

Lines changed: 29 additions & 116 deletions
Large diffs are not rendered by default.

docs/api/cmux.bashtoolargs.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

docs/api/cmux.bashtoolargs.script.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/api/cmux.bashtoolargs.timeout_secs.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/api/cmux.bashtoolresult.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/api/cmux.execoptions.abortsignal.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/api/cmux.execoptions.cwd.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)