Skip to content

Commit 507450c

Browse files
committed
edit texts for grammar and legibility and break down IDE plugin topic into chapters
1 parent 263404a commit 507450c

File tree

2 files changed

+39
-19
lines changed

2 files changed

+39
-19
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,10 @@ Check out our [getting started guide](https://kotlin.github.io/kotlinx-rpc) for
101101

102102
## Configure the project
103103

104-
### IDE Plugin
104+
### Plugin for IntelliJ-based IDEs
105105

106-
Install [Kotlin External FIR Support](https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true) IDE plugin.
107-
It will ensure that all IDE features of our compiler plugin work properly.
106+
To ensure that all IDE features of our compiler plugin work properly on IntelliJ-based IDEs, install the
107+
[Kotlin External FIR Support](https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true) plugin.
108108

109109
### Gradle plugins
110110

docs/pages/kotlinx-rpc/topics/ide-plugin.topic

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,41 @@
66
title="IDE Plugin" id="ide-plugin">
77

88
<p>
9-
Library uses a Kotlin compiler plugin to generate declarations.
10-
To make this work in Intellij-based IDEs,
11-
we provide <a href="https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true">Kotlin External FIR Support</a> plugin.
9+
The <code>kotlinx.rpc</code> library uses an external Kotlin compiler plugin to generate declarations.
10+
To ensure compatibility with IntelliJ-based IDEs, we provide the
11+
<a href="https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true">
12+
Kotlin External FIR Support
13+
</a>
14+
plugin.
1215
</p>
13-
<p>
14-
No additional steps to configure the plugin are required.
15-
</p>
16-
<p>
17-
If you encounter other unexpected limitations or bugs,
18-
please <a href="https://github.com/Mr3zee/kotlin-plugins/issues">report</a> them
19-
</p>
20-
<note>
21-
Please note, that the plugin is based on <b>experimental</b> IDE functionality,
22-
which means that only newer IDE versions are supported.
23-
For full compatibility guides, see the plugin page on the
24-
<a href="https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true">Marketplace</a>.
25-
</note>
16+
<chapter title="Supported versions" id="supported-versions">
17+
<p>
18+
The plugin is based on experimental IDE functionality,
19+
which means that only newer IDE versions are supported.
20+
For full compatibility guidelines, refer to the
21+
<a href="https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true">
22+
the plugin documentation on the JetBrains Marketplace
23+
</a>
24+
.
25+
</p>
26+
</chapter>
27+
<chapter title="Configuration" id="config">
28+
<p>
29+
No additional configuration is required. The plugin works automatically upon installation.
30+
</p>
31+
</chapter>
32+
<chapter title="Limitations" id="limitations">
33+
<p>
34+
There are currently no known limitations when using the plugin on supported IDE versions.
35+
</p>
36+
<p>
37+
If you encounter issues, unexpected limitations, or bugs,
38+
please report them by creating a new issue on
39+
<a href="https://github.com/Mr3zee/kotlin-plugins/issues">
40+
YouTRack
41+
</a>
42+
.
43+
</p>
44+
</chapter>
45+
2646
</topic>

0 commit comments

Comments
 (0)