diff --git a/.github/workflows/api-reference.yml b/.github/workflows/api-reference.yml index fb3f91b..46d08ee 100644 --- a/.github/workflows/api-reference.yml +++ b/.github/workflows/api-reference.yml @@ -25,11 +25,11 @@ jobs: runs-on: ubuntu-latest steps: - name: Setup Node.js 20 - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: 20 - name: Checkout source code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - uses: pnpm/action-setup@v3 with: version: 8.10.0 @@ -38,7 +38,7 @@ jobs: shell: bash run: | echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV - - uses: actions/cache@v3 + - uses: actions/cache@v4 name: Setup pnpm cache with: path: ${{ env.STORE_PATH }} @@ -48,7 +48,7 @@ jobs: - name: Install dependencies run: pnpm install --frozen-lockfile false - name: Generate API reference - run: pnpm generate-reference + run: pnpm generate:reference - name: Setup Pages uses: actions/configure-pages@v4 - name: Upload artifact diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index bfd5eb4..2587321 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -10,11 +10,11 @@ jobs: runs-on: ubuntu-latest steps: - name: Setup Node.js 20 - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: 20 - name: Checkout source code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Install pnpm uses: pnpm/action-setup@v3 with: @@ -24,7 +24,7 @@ jobs: shell: bash run: | echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV - - uses: actions/cache@v3 + - uses: actions/cache@v4 name: Setup pnpm cache with: path: ${{ env.STORE_PATH }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index c1d165d..8a7739b 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -21,11 +21,11 @@ jobs: # - windows-latest steps: - name: Setup Node.js ${{ matrix['node-version'] }} - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: ${{ matrix['node-version'] }} - name: Checkout source code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Install pnpm uses: pnpm/action-setup@v3 with: @@ -35,7 +35,7 @@ jobs: shell: bash run: | echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV - - uses: actions/cache@v3 + - uses: actions/cache@v4 name: Setup pnpm cache with: path: ${{ env.STORE_PATH }} diff --git a/.prettierignore b/.prettierignore index 95908ed..868112d 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,8 +1,10 @@ .vscode +.npmignore coverage dist node_modules **/*.wav +**/*.png **/.DS_Store LICENSE .gitignore diff --git a/README.md b/README.md index 3a32d49..e10384f 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ It is written primarily for Node.js in TypeScript with all types exported, but a ## Documentation Visit the [AssemblyAI documentation](https://www.assemblyai.com/docs) for step-by-step instructions and a lot more details about our AI models and API. +Explore the [SDK API reference](https://assemblyai.github.io/assemblyai-node-sdk/) for more details on the SDK types, functions, and classes. ## Quickstart diff --git a/package.json b/package.json index 5653dd5..0efec6e 100644 --- a/package.json +++ b/package.json @@ -71,7 +71,8 @@ "lint": "eslint -c .eslintrc.json '{src,tests}/**/*.{js,ts}' && publint && tsc --noEmit -p tsconfig.json", "test": "jest --config jest.config.js", "format": "prettier '**/*' --write", - "generate-types": "tsx ./scripts/generate-types.ts && pnpm format", + "generate:types": "tsx ./scripts/generate-types.ts && pnpm format", + "generate:reference": "typedoc", "copybara:dry-run": "./copybara.sh dry_run --init-history", "copybara:pr": "./copybara.sh sync_out --init-history" }, @@ -125,7 +126,8 @@ "ts-jest": "^29.1.2", "tslib": "^2.5.3", "typescript": "^5.4.2", - "typedoc": "^0.25.12" + "typedoc": "^0.25.12", + "typedoc-plugin-extras": "^3.0.0" }, "dependencies": { "ws": "^8.16.0" diff --git a/typedoc.json b/typedoc.json index 20178ca..c3277ce 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,5 +1,22 @@ { "entryPoints": ["src/index.ts"], + "plugin": ["typedoc-plugin-extras"], "out": "temp-docs", - "hideGenerator": true + "hideGenerator": true, + "name": "AssemblyAI JS SDK Reference", + "customTitle": "AssemblyAI JS SDK Reference", + "customDescription": "The API reference for the AssemblyAI JavaScript SDK.", + "favicon": "https://www.assemblyai.com/favicon.png", + "navigationLinks": { + "NPM": "https://www.npmjs.com/package/assemblyai", + "GitHub": "https://github.com/AssemblyAI/assemblyai-node-sdk", + "Docs": "https://www.assemblyai.com/docs/", + "Discord": "https://assemblyai.com/discord", + "Status": "https://status.assemblyai.com/", + "Playground": "https://www.assemblyai.com/playground", + "Dashboard": "https://www.assemblyai.com/app" + }, + "sidebarLinks": { + "README": "/assemblyai-node-sdk/index.html" + } }