Skip to content

Commit 26e8b03

Browse files
koshachyzamulla
andauthored
update: update Fleet documentation (JetBrains#134)
* feat: update Fleet docs * update: update wording Co-authored-by: Aleksey Zamulla <aleksey.zamulla@jetbrains.com> --------- Co-authored-by: Aleksey Zamulla <aleksey.zamulla@jetbrains.com>
1 parent d5db097 commit 26e8b03

File tree

5 files changed

+34
-28
lines changed

5 files changed

+34
-28
lines changed

mpd.tree

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@
6767
<toc-element toc-title="Releases" href="https://github.com/JetBrains/compose-multiplatform/blob/master/CHANGELOG.md"/>
6868
</toc-element>
6969
<toc-element toc-title="Kotlin Multiplatform technology" href="https://kotlinlang.org/docs/multiplatform.html"/>
70-
<toc-element toc-title="IDEs and tools">
70+
<toc-element toc-title="Tooling">
7171
<toc-element id="recommended-ides.md"/>
72-
<toc-element id="fleet.md" toc-title="Fleet IDE"/>
72+
<toc-element id="fleet.md" toc-title="Fleet code editor"/>
7373
<toc-element id="amper.md" toc-title="Amper configuration tool"/>
7474
</toc-element>
7575
<toc-element toc-title="Multiplatform Gradle DSL reference" href="https://kotlinlang.org/docs/multiplatform-dsl-reference.html"/>

topics/overview/faq.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ about [supported platforms](supported-platforms.md).
2525

2626
### In which IDE should I work on my cross-platform app?
2727

28-
We recommend using JetBrains Fleet or Android Studio, depending on your project needs and expectations.
29-
Learn more about which one to choose in [Recommended IDEs](recommended-ides.md).
28+
We recommend using JetBrains Fleet code editor or Android Studio IDE, depending on your project needs and expectations.
29+
Learn more about which one to choose in [Recommended IDEs and code editors](recommended-ides.md).
3030

3131
### How do I create a new Kotlin Multiplatform project?
3232

@@ -135,11 +135,11 @@ Developer Advocate Sebastian Aigner.
135135

136136
### What IDE should I use for building apps with Compose Multiplatform?
137137

138-
We recommend using JetBrains Fleet or Android Studio, depending on your project needs and expectations. To try
138+
We recommend using JetBrains Fleet code editor or Android Studio IDE, depending on your project needs and expectations. To try
139139
a new multiplatform experience without juggling different IDEs and switching to Xcode for writing Swift code,
140140
try out [JetBrains Fleet tutorial](fleet.md).
141141

142-
For more details on which one to choose, see [Recommended IDEs](recommended-ides.md).
142+
For more details on which one to choose, see [Recommended IDEs and code editors](recommended-ides.md).
143143

144144
### Can I play with a demo application? Where can I find it?
145145

topics/tools/fleet.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33
This article shows the basics of working with Kotlin Multiplatform projects
44
in [JetBrains Fleet](https://www.jetbrains.com/fleet/).
55

6-
Fleet is a modern IDE designed for collaborative development. It strives to provide a superior experience for
7-
Kotlin Multiplatform. As the first step, Fleet brings Kotlin Multiplatform to macOS.
6+
Fleet is a code editor for any language that can transform into a powerful development tool for any language.
7+
It strives to provide a superior experience for Kotlin Multiplatform.
8+
As the first step, Fleet brings Kotlin Multiplatform to macOS.
89

9-
With Fleet, you can quickly open and run multiplatform projects targeting Android, iOS, and desktop platforms.
10-
Fleet's Smart Mode selects the appropriate code-processing engine.
10+
With Fleet, you can quickly open and run multiplatform projects targeting Android, iOS, web, and desktop platforms.
11+
Fleet's Smart Mode automatically selects the appropriate code-processing engine.
1112

12-
When targeting iOS, navigation, refactoring, and debugging are all available across languages used in the project. This
13-
makes it easier to manage a mixed-language codebase. Fleet has full support for Swift, so you can easily extend and
14-
maintain the native parts of your application as well.
13+
When targeting iOS, navigation, refactoring, and debugging are available across all languages used in the project.
14+
This makes it easier to manage a mixed-language codebase.
15+
Fleet fully supports Swift out of the box, so you can extend and maintain the native parts of your application.
1516

1617
## Prepare your development environment
1718

@@ -83,9 +84,9 @@ In this tutorial, you'll create a new project with the web wizard:
8384

8485
At the top of the window, you'll see messages from Fleet as the project is imported and indexed.
8586

86-
When Smart Mode is enabled, Fleet operates as an IDE, with all of the code completion, navigation, debugging, and
87-
refactoring features available. When it's disabled, Fleet works as a simple file editor. You can quickly open files and
88-
make changes, but most of the productivity features won't be available.
87+
When Smart Mode is enabled, Fleet offers language-related features such as code completion,
88+
navigation, debugging, and refactoring. When Smart Mode is disabled, Fleet works as a simple code editor.
89+
You can quickly open files and make changes, but without most of the advanced language-related features.
8990

9091
Under the hood, Fleet chooses which backend to use to process code. When Smart Mode is enabled, the backend for
9192
Kotlin is the same code-processing engine used by IntelliJ IDEA, so the functionality you might be already familiar with
@@ -126,7 +127,7 @@ the [Get started with the Compose Multiplatform](compose-multiplatform-explore-c
126127
Let's see how cross-language navigation works in Fleet using the example of navigating from Kotlin to Swift:
127128

128129
1. Open the `composeApp/src/commonMain/kotlin/App.kt` file. Here's the `App` composable, the center of the sample code.
129-
2. Select the `App()` function and run the **Usages** action form the context menu or with the <shortcut>⌘ U</shortcut>
130+
2. Select the `App()` function and run the **Usages** action from the context menu or with the <shortcut>⌘ U</shortcut>
130131
shortcut. You can see it is invoked in three files:
131132

132133
![Function show usages](fleet-show-usages.png){width=700}
@@ -145,7 +146,7 @@ Let's see how cross-language navigation works in Fleet using the example of navi
145146

146147
Since the `ContentView.swift` file is already open, you can explore Fleet support for editing Swift code:
147148

148-
1. Add a new function to the `ComposeView` type. Fleet will provide all of the expected coding assistance:
149+
1. Add a new function to the `ComposeView` type. Fleet will provide all the expected coding assistance:
149150

150151
```swift
151152
struct ComposeView: UIViewControllerRepresentable {

topics/tools/recommended-ides.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
1-
[//]: # (title: Recommended IDEs)
1+
[//]: # (title: Recommended IDEs and code editors)
22

3-
## Fleet
3+
## JetBrains Fleet code editor
44

5-
If you want the best Kotlin Multiplatform development experience, we recommend using [JetBrains Fleet](https://www.jetbrains.com/fleet/).
5+
For the best Kotlin Multiplatform development experience, we recommend using [JetBrains Fleet](https://www.jetbrains.com/fleet/).
6+
Fleet is a code editor for any language that can transform into a more powerful tool for development.
7+
It is designed to be smart and focused on core development workflows (the edit-build-run loop),
8+
AI-capable, and ready for remote development and collaboration.
69

7-
It supports testing and debugging your code on all of the platforms your project targets. You can also navigate between Kotlin
10+
Fleet supports testing and debugging your code on all target platforms. You can also navigate between Kotlin
811
Multiplatform code and code written in other languages interoperable with Kotlin.
912

1013
See the [Use Fleet for Multiplatform development](fleet.md) tutorial to get started.
1114

12-
Kotlin Multiplatform support in Fleet is still in the early stages of development. You may face issues and
13-
limitations, but we're committed to fixing them based on [your feedback](fleet.md#leave-feedback).
15+
> Kotlin Multiplatform support in Fleet is still in the early stages of development. You may face issues and
16+
> limitations, but we're committed to fixing them based on [your feedback](fleet.md#leave-feedback).
17+
>
18+
{type="note"}
1419

15-
## Android Studio
20+
## Android Studio IDE
1621

1722
As a more stable solution, you can use [Android Studio](https://developer.android.com/studio),
1823
although its support for Kotlin Multiplatform is limited.
1924

2025
With Android Studio, you can also install a [special plugin](https://plugins.jetbrains.com/plugin/14936-kotlin-multiplatform-mobile)
2126
that provides minimal launching and debugging capabilities for iOS apps.
2227

23-
## Other IDEs
28+
## Other IDEs and code editors
2429

2530
If basic Kotlin Multiplatform support is enough for you, you can use any IDE that supports Kotlin, including [IntelliJ IDEA](https://www.jetbrains.com/idea/).
2631
It supports opening, browsing, and building multiplatform projects.

topics/whats-new/whats-new-fleet-1-31.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ Currently, Fleet does not rebuild previews automatically, so click the icon agai
2020
{type="note"}
2121

2222
For more about the feature, see [Getting started with Kotlin Multiplatform](https://www.jetbrains.com/help/fleet/getting-started-with-kotlin-multiplatform.html#b65b852e_76)
23-
in Fleet documentation.
23+
in the Fleet documentation.
2424

2525
## Support for Compose Multiplatform resources API
2626

2727
The latest version of the [images and resources access API](compose-images-resources.md), revamped in Compose Multiplatform 1.6.0,
2828
is supported in Fleet.
2929

30-
The IDE:
30+
Starting with this version, JetBrains Fleet:
3131

3232
* Autocompletes resources calls
3333
* Allows navigation to resources referenced in code

0 commit comments

Comments
 (0)