Docs: Generate TypeDoc from API#257
Merged
Merged
Conversation
- Created package.json and package-lock.json for managing dependencies. - Added TypeScript configuration (tsconfig.json) for the project. - Implemented a script (prepare-readme.mjs) to generate a README from the SDK core. - Introduced a custom TypeDoc plugin (typedoc-plugin.mjs) for enhanced documentation generation. - Added .gitignore to exclude unnecessary files from version control. - Configured TypeDoc settings in typedoc.json for output and entry points.
- Added scripts for building and verifying API documentation in the docs/api directory. - Updated package.json to include new documentation build commands. - Introduced a GitHub Actions workflow for generating and uploading API documentation on release. - Improved TypeDoc configuration and added version syncing for @sinch/sdk-core dependency. - Enhanced README generation and verification processes for better documentation quality.
- Introduced a new workflow to generate and upload API documentation upon release or manual trigger. - Validates version format using semver before proceeding with documentation build. - Packages the generated documentation and uploads it to the GitLab Registry. - Triggers a downstream GitLab pipeline to notify about the new documentation package version. - Removed the previous API documentation steps from the publish-on-release workflow for better separation of concerns.
Hurus111
requested review from
JPPortier,
asein-sinch and
matsk-sinch
as code owners
JPPortier
approved these changes
Jun 15, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.