Skip to content

Commit d8a0c8a

Browse files
chtituxclaude
andcommitted
Add TypeDoc API docs and simplify README
- Add TypeDoc with projectDocuments for a detailed Usage Guide - Move all detailed examples from README into documents/guide.md - Simplify README to concise overview with links to docs - Add API Reference link to website navbar - Update GitHub Pages workflow to build and deploy TypeDoc output Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 6ced94e commit d8a0c8a

9 files changed

Lines changed: 1270 additions & 1039 deletions

File tree

‎.github/workflows/pages.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ jobs:
4040
working-directory: ./website
4141
run: npm run build
4242

43+
- name: Build API docs with TypeDoc
44+
run: npx typedoc
45+
46+
- name: Copy API docs to website
47+
run: cp -r typedoc-out website/dist/docs
48+
4349
- name: Setup Pages
4450
uses: actions/configure-pages@v4
4551

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ node_modules/
33

44
# Build outputs
55
dist/
6+
typedoc-out/
67
*.tsbuildinfo
78

89
# Test coverage

0 commit comments

Comments
 (0)