Add support for detailed plugin descriptions#11935
Merged
Merged
Conversation
Rename the `description` property of the `OrtPlugin` annotation and the `PluginDescriptor` to `summary` as it captures only a short description of the plugin. Using it for longer descriptions is inconvenient because it is taken from a property of the `OrtPlugin` annotation which must be a compile time constant. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@doubleopen.io>
Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@doubleopen.io>
Similar to the description of plugin options, the value is taken from the KDoc of the plugin class. This allows to use it for longer descriptions containing Markdown. The property is optional, as not all plugins require a detailed description. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@doubleopen.io>
mnonnenmacher
requested review from
a team,
MarcelBochtler and
oheger-bosch
as code owners
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
mnonnenmacher
force-pushed
the
plugin-descriptions
branch
from
9698fb0 to
ad357d0
Compare
sschuberth
reviewed
Jun 3, 2026
| id = pluginId, | ||
| displayName = ortPlugin.displayName, | ||
| summary = ortPlugin.summary, | ||
| description = pluginClass.docString?.trim(), |
Member
There was a problem hiding this comment.
Why is this trimmed whereas summary is not?
Member
Author
There was a problem hiding this comment.
Because it's coming from a different source, the doc string for option descriptions is also trimmed.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11935 +/- ##
=========================================
Coverage 58.43% 58.43%
- Complexity 1807 1809 +2
=========================================
Files 361 361
Lines 13499 13499
Branches 1383 1383
=========================================
Hits 7888 7888
Misses 5115 5115
Partials 496 496
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Also emphasize the plugin summaries to visually separate them from the descriptions. As the plugin descriptions are taken from the KDoc of the plugin classes, replace any KDoc symbol links with inline code blocks. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@doubleopen.io>
Also document the requirements to ensure descriptions are nicely rendered on the website. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@doubleopen.io>
Apply some trivial improvements to ensure that the plugins docs are rendered nicely on the website. This mainly consists of fixing links. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@doubleopen.io>
As detailed descriptions of plugins are now supported and automatically added to the website, move the docs of the `OrtProject` package manager to the plugin itself. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@doubleopen.io>
mnonnenmacher
force-pushed
the
plugin-descriptions
branch
from
ad357d0 to
796efaa
Compare
sschuberth
approved these changes
Jun 3, 2026
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
3 participants
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.
Rename the
descriptionproperty of@OrtPlugintosummaryto emphasize that it is a short description. Using it for detailed descriptions is not convenient, because annotation properties must be compile time constants. Instead, take the detailed description from the KDoc of the plugin class, similar to how it is done for plugin options.Also show the detailed descriptions on the website and apply some trivial improvements to the existing plugin KDocs to improve how they are shown on the website. Generally improving the plugin docs is out of scope for this PR.
See the commit messages for details.
Example for the
OrtProjectpackage manager plugin: