-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update plugin API docs for headless plugins and Inversify DI #13299
Update plugin API docs for headless plugins and Inversify DI #13299
Conversation
Update the plugin API documentation to cover - headless plugins - Inversify DI in the plugin host - simplified ext API initialization and API factory using new PluginContainerModule capability Fixes eclipse-theia#13290 Signed-off-by: Christian W. Damus <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you very much for that great update, Christian! I have a few comments and may also ask other people to chime. Really grateful you also fixed some of the typos ;-)
Should this maybe also be mentioned here: https://theia-ide.org/docs/extensions/ |
@JonasHelming Very good point! I fully agree that we should also mention in on the website doc! |
- address specific review comments, generally clarifying the text - rationalize sentence forms of bullet lists - add a diagram showing the subtle difference in architecture of the VS Code plugin hosts and headless plugin host Signed-off-by: Christian W. Damus <[email protected]>
Thanks @martin-fleck-at for the thorough review. Very helpful! I've pushed commit 7063d6e that I hope should address your comments. Updates to the website will require a separate PR on that repository. |
|
@cdamus Great job with this new documentation. With the new plugin type in the mix, this stuff is even trickier to explain than it was before. You did so as best as it could have been done, IMO. |
- minor updates to the text for better clarity and precision Signed-off-by: Christian W. Damus <[email protected]>
Thanks @jcortell68 for the review! Commit 2ed73f3 should be better than ever. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great. Thanks for the adjustments!
Quick-fix action test failures on Ubuntu Linux are the same as occurred in the commit(s) on which this PR is based, so not a regression in this PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cdamus Thank you very much for the enhanced documentation! I think that adds great value, especially with new images and further clarifications.
What it does
Update the plugin API documentation to cover
How to test
Read and critique the updated documentation pages at
Follow-ups
No further documentation changes are identified at this time.
Review checklist
Reminder for reviewers