Update typedoc to latest and fix json generation. Add typedoc configs per package.#132
Open
Update typedoc to latest and fix json generation. Add typedoc configs per package.#132
Conversation
Contributor
|
The generation works and the missing apis are visible now, but the output is going to the |
Member
Author
|
@dkamburov The folder shouldn't be an issue, since I've updated the pipeline to use it as the new source for the old typedoc. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repo’s TypeDoc toolchain/configuration to generate both legacy HTML docs and per-package JSON outputs, and adjusts the custom TypeDoc plugin to include inherited/base-class members (addressing the missing-properties issue described in #135).
Changes:
- Added per-package TypeDoc option files for JSON output generation and a legacy options file for HTML output.
- Updated build scripts and Azure pipeline packaging to use the new legacy output folder layout.
- Updated the custom TypeDoc plugin to traverse base types for member extraction and added logic intended to avoid JSON circular references.
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| typedoc.json | Base TypeDoc configuration; removes default out so output location is controlled by option files. |
| typedoc.legacy.json | New legacy HTML output configuration targeting ./typedocs/legacy/. |
| typedoc.components.json | New per-package JSON output config for core components/grid-lite. |
| typedoc.dock-manager.json | New per-package JSON output config for dock manager. |
| typedoc.grids.json | New per-package JSON output config for grids. |
| plugins/typedoc-plugin-react-components/src/main.ts | Extends member parsing to include base types; adds comment sanitization intended for JSON generation. |
| plugins/typedoc-plugin-react-components/package.json | Tweaks plugin scripts/formatting (notably removes dist clean step). |
| package.json | Updates TypeDoc scripts, adds per-package build commands, bumps TypeDoc/theme/plugin deps. |
| package-lock.json | Locks updated TypeDoc/theme/localization deps and adds merge-modules plugin. |
| .azure-pipelines/api-docs.yml | Archives legacy TypeDoc output from typedocs/legacy instead of typedocs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Closes #135