diff --git a/README.md b/README.md index 442bb645..c574003c 100644 --- a/README.md +++ b/README.md @@ -101,10 +101,10 @@ Check out our [getting started guide](https://kotlin.github.io/kotlinx-rpc) for ## Configure the project -### IDE Plugin +### Plugin for IntelliJ-based IDEs -Install [Kotlin External FIR Support](https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true) IDE plugin. -It will ensure that all IDE features of our compiler plugin work properly. +To ensure that all IDE features of our compiler plugin work properly on IntelliJ-based IDEs, install the +[Kotlin External FIR Support](https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true) plugin. ### Gradle plugins diff --git a/docs/pages/kotlinx-rpc/topics/ide-plugin.topic b/docs/pages/kotlinx-rpc/topics/ide-plugin.topic index 1673fd3e..071a5ec0 100644 --- a/docs/pages/kotlinx-rpc/topics/ide-plugin.topic +++ b/docs/pages/kotlinx-rpc/topics/ide-plugin.topic @@ -6,21 +6,41 @@ title="IDE Plugin" id="ide-plugin">

- Library uses a Kotlin compiler plugin to generate declarations. - To make this work in Intellij-based IDEs, - we provide Kotlin External FIR Support plugin. + The kotlinx.rpc library uses an external Kotlin compiler plugin to generate declarations. + To ensure compatibility with IntelliJ-based IDEs, we provide the + + Kotlin External FIR Support + + plugin.

-

- No additional steps to configure the plugin are required. -

-

- If you encounter other unexpected limitations or bugs, - please report them -

- - Please note, that the plugin is based on experimental IDE functionality, - which means that only newer IDE versions are supported. - For full compatibility guides, see the plugin page on the - Marketplace. - + +

+ The plugin is based on experimental IDE functionality, + which means that only newer IDE versions are supported. + For full compatibility guidelines, refer to the + + the plugin documentation on the JetBrains Marketplace + + . +

+
+ +

+ No additional configuration is required. The plugin works automatically upon installation. +

+
+ +

+ There are currently no known limitations when using the plugin on supported IDE versions. +

+

+ If you encounter issues, unexpected limitations, or bugs, + please report them by creating a new issue on + + YouTRack + + . +

+
+ \ No newline at end of file