Repository navigation
chore: add @packageDescription to plugins - #10652
Merged
zspriggs merged 4 commits intoNov 3, 2026
Merged
Conversation
lizschwab
approved these changes
Nov 3, 2026
lizschwab
left a comment
lizschwab
left a comment
Contributor
There was a problem hiding this comment.
This looks good. I don't know why there are linting errors about empty lines but only on some files. All the plugins should have the same rules. But the lint step passed so I wouldn't worry too much about it. ¯_(ツ)_/¯
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.
The basics
The details
Resolves
Fixes #10641
Proposed Changes
Adds
@packageDocumentationto each plugin, so that plugin descriptions show on the plugins API landing page. Descriptions are taken from thepackage.jsonof each plugin, except forworkspace-minimapsince that didn't have a real description.@packageDocumentationreplaces@fileoverviewwhen applicable.@fileoverviewis also added to the list of ignored tags for TypeDoc in the pluginstypedoc.json. TypeDoc attaches@fileoverviewto whatever comes immediately after it, so descriptions of a whole file end up on the API doc page for whichever class, interface, etc that happens to be declared first. Note that there's also a few other tags (the default tags for TypeDoc) added, since adding ignored tags overrides TypeDoc's defaults.Reason for Changes
Right now, the reference docs landing page for plugins is name of the plugin with an empty description column.
@packageDocumentationtells TypeDoc those descriptions.Test Coverage
Documentation
Additional Information
Note that as of right now, we haven't deployed docs yet since the plugins API changes were made, so if you'd like to see what the landing page looked like before this PR, run docs locally from main.