feat: Add typedoc references generation #515
Open
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: 873ce8e The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
atierian
approved these changes
Jan 31, 2025
zxl629
reviewed
Jan 31, 2025
| { | ||
| "name": "Amplify Data API Documentation", | ||
| "entryPointStrategy": "packages", | ||
| "entryPoints": [ |
There was a problem hiding this comment.
Do we want to create a single JSON output or separate them?
zxl629
approved these changes
Jan 31, 2025
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.
Problem
This adds
npm run typedocwhich generates atypedoc/references.jsonfile that is the basis for publishing API references to the docs site.The goal is to avoid checking this references file into this repository and instead triggering a PR on docs site, which will be done in a GH workflow that will come with a subsequent change.
Validation
Running
npm run typedocgeneratestypedoc/references.jsonChecklist
NA
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.