refactor(content-docs): deduplicate types, JSDoc for some APIs #7027
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.
Breaking change
This should be mostly internal, but if you enhanced the doc plugin or monkey-patched it in a 3rd party plugin and relied on internal data structures like version metadata, their shapes may have changed. Most notably,
versionMetadata.version*
have theversion
prefix stripped except forversionName
, soversionBadge
becomesbadge
,versionPath
->path
, etc. Swizzled themes or client APIs are not affected.Motivation
The great type deduplication, because we want to re-use JSDoc😞
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Build