Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix API Doc generation #1464

Merged
merged 4 commits into from
May 4, 2023
Merged

Fix API Doc generation #1464

merged 4 commits into from
May 4, 2023

Conversation

addy-pathania
Copy link
Contributor

@addy-pathania addy-pathania commented May 2, 2023

The typescript version present in the root package.json file was incompatible with the types within the packages which caused the api generation to fail.

Description / Motivation

Testing Details

  • Unit Test Added
  • Manual Test/Other (Please elaborate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

@addy-pathania addy-pathania requested a review from a team May 2, 2023 20:48
Copy link
Contributor

@illiakovalenko illiakovalenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra question regarding warnings during typedoc generation
is it fixed? I guess it's also expected to be done

CHANGELOG.md Outdated Show resolved Hide resolved
package.json Show resolved Hide resolved
@addy-pathania
Copy link
Contributor Author

Extra question regarding warnings during typedoc generation is it fixed? I guess it's also expected to be done

When we generate docs from the root there are no warnings. Docs generated for individual packages has warnings which is the case for all the packages. Should this be covered in a separate PBI ?

@illiakovalenko illiakovalenko merged commit 46e924e into dev May 4, 2023
@illiakovalenko illiakovalenko deleted the bug/578373-api-doc-fail branch May 4, 2023 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants