Skip to content

[#382] Fix Warnings in api-docs pipeline#491

Merged
rido-min merged 1 commit intomainfrom
southworks/fix/typedoc-warnings
Jul 24, 2025
Merged

[#382] Fix Warnings in api-docs pipeline#491
rido-min merged 1 commit intomainfrom
southworks/fix/typedoc-warnings

Conversation

@ceciliaavila
Copy link
Copy Markdown
Collaborator

Fixes #382

Description

This PR fixes the error JSDoc issues causing warnings in the typeDoc check.

Detailed Changes

  • Removed the TurnContext interface. This interface was empty and unused, leading to ambiguity in TypeDoc.
  • Re-exported the TurnContext type in agents-hosting-dialogs/src/index.ts because it wasn't resolving the docs correctly.
  • Removed env as language identifies in agents-copilotstudio-client/README.md, as it wasn't supported.
  • Fixed @link references in different files.
  • Added missing exports in index.ts files
  • Removed unsupported tags @const and @mention from comments.
  • Removed outdated @param comments.

Testing

This image shows the typedoc command executed without warnings.
image

@rido-min rido-min requested a review from JimDaly July 24, 2025 17:26
Copy link
Copy Markdown
Member

@JimDaly JimDaly left a comment

Choose a reason for hiding this comment

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

Looks good to me

@rido-min rido-min merged commit 4e7cd75 into main Jul 24, 2025
7 checks passed
@rido-min rido-min deleted the southworks/fix/typedoc-warnings branch July 24, 2025 19:46
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.

Fix Warnings in api-docs pipeline

3 participants