edit texts for grammar and legibility and break down IDE plugin topic…

… into chapters
Kotlin · Feb 10, 2025 · 507450c · 507450c
1 parent 263404a
commit 507450c
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 19 deletions.
diff --git 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
@@ -6,21 +6,41 @@
        title="IDE Plugin" id="ide-plugin">
 
     <p>
-        Library uses a Kotlin compiler plugin to generate declarations.
-        To make this work in Intellij-based IDEs,
-        we provide <a href="https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true">Kotlin External FIR Support</a> plugin.
+        The <code>kotlinx.rpc</code> library uses an external Kotlin compiler plugin to generate declarations.
+        To ensure compatibility with IntelliJ-based IDEs, we provide the
+        <a href="https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true">
+            Kotlin External FIR Support
+        </a>
+        plugin.
     </p>
-    <p>
-        No additional steps to configure the plugin are required.
-    </p>
-    <p>
-        If you encounter other unexpected limitations or bugs,
-        please <a href="https://github.com/Mr3zee/kotlin-plugins/issues">report</a> them
-    </p>
-    <note>
-        Please note, that the plugin is based on <b>experimental</b> IDE functionality,
-        which means that only newer IDE versions are supported.
-        For full compatibility guides, see the plugin page on the
-        <a href="https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true">Marketplace</a>.
-    </note>
+    <chapter title="Supported versions" id="supported-versions">
+        <p>
+            The plugin is based on experimental IDE functionality,
+            which means that only newer IDE versions are supported.
+            For full compatibility guidelines, refer to the
+            <a href="https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true">
+                the plugin documentation on the JetBrains Marketplace
+            </a>
+            .
+        </p>
+    </chapter>
+    <chapter title="Configuration" id="config">
+        <p>
+            No additional configuration is required. The plugin works automatically upon installation.
+        </p>
+    </chapter>
+    <chapter title="Limitations" id="limitations">
+        <p>
+            There are currently no known limitations when using the plugin on supported IDE versions.
+        </p>
+        <p>
+            If you encounter issues, unexpected limitations, or bugs,
+            please report them by creating a new issue on
+            <a href="https://github.com/Mr3zee/kotlin-plugins/issues">
+                YouTRack
+            </a>
+            .
+        </p>
+    </chapter>
+
 </topic>