Skip to content

Conversation

ankbatecm
Copy link

COMPLETES

This pull request addresses

This change adds support for generating Typedoc output in JSON format.
It is necessary to enable processing of the SDK public APIs for my use case.

by making the following changes

Added a new script build:docs:json to relevant package.json files.
The build:docs:json script runs Typedoc to generate documentation in JSON format

Change Type

  • 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)
  • Documentation update
  • Tooling change
  • Internal code refactor

The following scenarios were tested

Verified that running yarn run build:docs:json produces the expected Typedoc JSON output.

The GAI Coding Policy And Copyright Annotation Best Practices

  • GAI was not used (or, no additional notation is required)
  • Code was generated entirely by GAI
  • GAI was used to create a draft that was subsequently customized or modified
  • Coder created a draft manually that was non-substantively modified by GAI (e.g., refactoring was performed by GAI on manually written code)
  • Tool used for AI assistance (GitHub Copilot / Other - specify)
    • Github Copilot
    • Other - Please Specify
  • This PR is related to
    • Feature
    • Defect fix
    • Tech Debt
    • Automation

I certified that

  • I have read and followed contributing guidelines
  • I discussed changes with code owners prior to submitting this pull request
  • I have not skipped any automated checks
  • All existing and new tests passed
  • I have updated the documentation accordingly

Make sure to have followed the contributing guidelines before submitting.

@ankbatecm ankbatecm requested a review from a team as a code owner October 7, 2025 08:44
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-4519.d3m3l2kee0btzx.amplifyapp.com

@Kesari3008 Kesari3008 added the validated If the pull request is validated for automation. label Oct 10, 2025
Copy link
Contributor

@Kesari3008 Kesari3008 left a comment

Choose a reason for hiding this comment

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

Did we try to run this command after updating package.json ? If yes, is it possible to share screenshot or some reference of how and where will be hosting the JSON data and what it looks like.

Also I am assuming we are trying to run this command from the model and just read it live and we won;t really be pushing and saving these JSON files that are getting created in docs folder ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

validated If the pull request is validated for automation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants