From 263404aa90a4f681ca2f92070faeeaedfc0852ea Mon Sep 17 00:00:00 2001 From: Alexander Sysoev Date: Fri, 7 Feb 2025 11:58:46 +0100 Subject: [PATCH 1/3] Added IDE plugin docs --- README.md | 7 ++++- docs/pages/kotlinx-rpc/rpc.tree | 1 + .../kotlinx-rpc/topics/get-started.topic | 10 +++++++ .../pages/kotlinx-rpc/topics/ide-plugin.topic | 26 +++++++++++++++++++ docs/pages/kotlinx-rpc/topics/plugins.topic | 2 +- 5 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 docs/pages/kotlinx-rpc/topics/ide-plugin.topic diff --git a/README.md b/README.md index e3987ff93..442bb6459 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,12 @@ Check out our [getting started guide](https://kotlin.github.io/kotlinx-rpc) for ## Configure the project -### Plugin dependencies +### IDE Plugin + +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. + +### Gradle plugins `kotlinx.rpc` provides Gradle plugin `org.jetbrains.kotlinx.rpc.plugin` that will set up code generation in a project. diff --git a/docs/pages/kotlinx-rpc/rpc.tree b/docs/pages/kotlinx-rpc/rpc.tree index e671d020f..aef7ccde8 100644 --- a/docs/pages/kotlinx-rpc/rpc.tree +++ b/docs/pages/kotlinx-rpc/rpc.tree @@ -11,6 +11,7 @@ start-page="get-started.topic"> + diff --git a/docs/pages/kotlinx-rpc/topics/get-started.topic b/docs/pages/kotlinx-rpc/topics/get-started.topic index 6ba7fe8f1..72e616d67 100644 --- a/docs/pages/kotlinx-rpc/topics/get-started.topic +++ b/docs/pages/kotlinx-rpc/topics/get-started.topic @@ -41,6 +41,16 @@ including but not limited to gRPC.

+ +

+ Library uses a Kotlin compiler plugin to generate declarations. + To make this work in Intellij-based IDEs, + we provide Kotlin External FIR Support plugin. +

+

+ To learn more, see page +

+

Before adding kotlinx.rpc dependencies, you need to configure your project with Gradle. diff --git a/docs/pages/kotlinx-rpc/topics/ide-plugin.topic b/docs/pages/kotlinx-rpc/topics/ide-plugin.topic new file mode 100644 index 000000000..1673fd3ee --- /dev/null +++ b/docs/pages/kotlinx-rpc/topics/ide-plugin.topic @@ -0,0 +1,26 @@ + + + + +

+ Library uses a Kotlin compiler plugin to generate declarations. + To make this work in Intellij-based IDEs, + we provide 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. + + \ No newline at end of file diff --git a/docs/pages/kotlinx-rpc/topics/plugins.topic b/docs/pages/kotlinx-rpc/topics/plugins.topic index 7e1620329..2c0db9c33 100644 --- a/docs/pages/kotlinx-rpc/topics/plugins.topic +++ b/docs/pages/kotlinx-rpc/topics/plugins.topic @@ -7,7 +7,7 @@ SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd"> + title="Gradle plugin" id="plugins">

The kotlinx.rpc library offers a Gradle plugin that simplifies project configuration by automating repetitive tasks: `org.jetbrains.kotlinx.rpc.plugin` From 507450c8cc1b1e53341cf726c75887a50df7b332 Mon Sep 17 00:00:00 2001 From: Viktoriya Nikolova Date: Mon, 10 Feb 2025 11:32:40 +0100 Subject: [PATCH 2/3] edit texts for grammar and legibility and break down IDE plugin topic into chapters --- README.md | 6 +-- .../pages/kotlinx-rpc/topics/ide-plugin.topic | 52 +++++++++++++------ 2 files changed, 39 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 442bb6459..c574003cc 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 1673fd3ee..071a5ec02 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 From 1c8d64fed958b00959c9e0adfa4e41d756082fcd Mon Sep 17 00:00:00 2001 From: Alexander Sysoev Date: Mon, 10 Feb 2025 12:52:24 +0100 Subject: [PATCH 3/3] Fix typo --- docs/pages/kotlinx-rpc/topics/ide-plugin.topic | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/kotlinx-rpc/topics/ide-plugin.topic b/docs/pages/kotlinx-rpc/topics/ide-plugin.topic index 071a5ec02..10eea4727 100644 --- a/docs/pages/kotlinx-rpc/topics/ide-plugin.topic +++ b/docs/pages/kotlinx-rpc/topics/ide-plugin.topic @@ -37,10 +37,10 @@ If you encounter issues, unexpected limitations, or bugs, please report them by creating a new issue on - YouTRack + GitHub .

- \ No newline at end of file +