fix: resolve docs deployment failure and add PR validation #388
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The docs build was failing due to `baseUrl is not defined` errors during static site generation. This was caused by JSDoc @deprecated comments containing JavaScript-like syntax with curly braces (e.g., `{ baseUrl, customFetch }`) that were being interpreted as JavaScript expressions in the generated MDX files. Added `sanitizeComments: true` to the TypeDoc plugin configuration to properly escape these expressions in the generated documentation. Fixes workflow failure: https://github.com/Doist/todoist-api-typescript/actions/runs/19192983941 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Add a new GitHub workflow that validates documentation builds on pull requests to catch docs deployment issues before they reach the main branch. The workflow: - Triggers on PRs that modify source code, docs, or dependencies - Builds the documentation using the same steps as deployment - Validates that the build completes successfully - Provides clear success/failure feedback This prevents docs deployment failures like the recent baseUrl issue from breaking the main branch deployment. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
scottlovegrove
added a commit
to Doist/twist-sdk-typescript
that referenced
this pull request
Nov 8, 2025
…lures
Adds sanitizeComments: true to the TypeDoc plugin configuration to properly escape JavaScript-like syntax in JSDoc comments (e.g., { baseUrl, customFetch }) that could break documentation builds.
This prevents the same issue that occurred in the Todoist SDK where curly braces in @deprecated comments were interpreted as JavaScript expressions in generated MDX files during static site generation.
Refs: Doist/todoist-api-typescript#388
scottlovegrove
added a commit
to Doist/twist-sdk-typescript
that referenced
this pull request
Nov 8, 2025
Adds a new GitHub workflow that validates documentation builds on pull requests to prevent deployment failures. The workflow: - Runs on PRs that modify source code, website files, or dependencies - Builds the Docusaurus documentation site - Validates that the build succeeds and generates expected files - Catches issues like JSDoc comment syntax errors before merge This prevents the same docs deployment failures that occurred in the Todoist SDK, where invalid JSDoc comments broke the build after merge. Refs: Doist/todoist-api-typescript#388
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
baseUrl is not definederrorsRoot Cause
The docs deployment was failing due to JSDoc
@deprecatedcomments containing JavaScript-like syntax with curly braces (e.g.,{ baseUrl, customFetch }) that were being interpreted as JavaScript expressions in the generated MDX files during static site generation.Solution
sanitizeComments: trueto the TypeDoc plugin configuration to properly escape these expressions in generated documentationvalidate-docs.yml) that validates documentation builds on pull requestsTesting
Links
🤖 Generated with Claude Code