diff --git a/docs/wiki/INSTALLATION.md b/docs/wiki/INSTALLATION.md index ff1be12f..96108c93 100644 --- a/docs/wiki/INSTALLATION.md +++ b/docs/wiki/INSTALLATION.md @@ -14,11 +14,14 @@ Check the extension [README](../../src/vscode/contextive/README.md) for usage in ### IntelliJ Plugin Platform +> [!WARNING] +> This plugin is considered 'beta' status, as leverages relatively new [Language Server Protocol](https://plugins.jetbrains.com/docs/intellij/language-server-protocol.html) support from JetBrains which is still marked as unstable in the IntelliJ Platform API. Some features may not work or may not work as expected. Please [report issues](https://github.com/dev-cycles/contextive/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=) in this project and we will liaise with JetBrains to resolve. + Open your JetBrains product, e.g. IntelliJ IDEA, or JetBrains Rider, open the Settings dialog and choose "Plugins". Search `contextive` in the Marketplace tab and click the `Install` button. See JetBrains documentation on [installing plugins](https://www.jetbrains.com/help/idea/managing-plugins.html), and visit the [Contextive Plugin](https://plugins.jetbrains.com/plugin/23928-contextive) JetBrains Marketplace page for details. -Check the plugin [README](../../src/intellij/contextive/README.md) for usage instructions. +Check the plugin [README](../../src/intellij/contextive/README.md) for usage instructions, known issues and links to related JetBrains issues with the Language Server Protocol support.. ## Language Server Configurations diff --git a/src/intellij/contextive/README.md b/src/intellij/contextive/README.md index cc26a4b6..4c08b86e 100644 --- a/src/intellij/contextive/README.md +++ b/src/intellij/contextive/README.md @@ -4,6 +4,11 @@ Contextive is an IntelliJ Platform Plugin to assist developers in environments w It should help new team members get up to speed more quickly in understanding domain-specific terms. By storing the term definitions in your repository, and surfacing the definitions as you work on the code, it encourages the use of the domain-specific terms in your code, and regularly updating the definitions as the team's understanding evolves. +> [!WARNING] +> This plugin is considered 'beta' status, as leverages relatively new [Language Server Protocol](https://plugins.jetbrains.com/docs/intellij/language-server-protocol.html) support from JetBrains which is still marked as unstable in the IntelliJ Platform API. Some features may not work or may not work as expected. Please [report issues](https://github.com/dev-cycles/contextive/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=) in this project and we will liaise with JetBrains to resolve. +> +> See [known issues](#known-issues) below + ## Installation See [IntelliJ IDEs (e.g. IDEA, Rider) Installation Instructions](https://github.com/dev-cycles/contextive/blob/main/docs/wiki/INSTALLATION.md#intellij-plugin-platform). @@ -30,7 +35,7 @@ At time of writing, it includes: * Aqua * DataGrip * GoLand -* Rider +* Rider - [not working in C# files](https://github.com/dev-cycles/contextive/issues/65) * RustRover ## Usage Guide @@ -75,4 +80,5 @@ This is pending IntelliJ support for the LSP `workspace/configuration` feature. * Not configurable - see [Plugin Configuration](#plugin-configuration) * Autocomplete list doesn't respect the case sensitive interpretation as described in the usage guide. IntelliJ does not yet respect the `isIncomplete' flag that forces re-computation of the list and is required to adjust the case of list items. See [IDEA-348829](https://youtrack.jetbrains.com/issue/IDEA-348829) for details. * Documentation not shown on hover in some files (files treated as 'plaintext' by the specific IDE). Use F1 to show the hover documentation at the current cursor position. This is an IntelliJ bug, see [IDEA-348497](https://youtrack.jetbrains.com/issue/IDEA-348497/Doc-popup-doesnt-appear-on-hover-in-LSP-API-based-plugins) for details. -* Auto-completion does not work at certain positions. See [Issue #63](https://github.com/dev-cycles/contextive/issues/63) \ No newline at end of file +* Auto-completion does not work at certain positions. See [Issue #63](https://github.com/dev-cycles/contextive/issues/63) +* In Rider, C# files do not show documentation on hover, or 'quick documentation shortcut', or documentation during auto-complete. See [Issue #65](https://github.com/dev-cycles/contextive/issues/65) \ No newline at end of file