Merge pull request #839 from Kotlin/ermolenko/KTNB-731

Add documentation for Kotlin Notebook Plugin usage and troubleshooting

Author: ermolenkodev

docs/StardustDocs/d.tree

@@ -186,5 +186,8 @@
         </toc-element>
     </toc-element>
     <toc-element topic="gradleReference.md"/>
+    <toc-element topic="Usage-with-Kotlin-Notebook-Plugin.md">
+        <toc-element topic="Trobleshooting.md"/>
+    </toc-element>
     <toc-element href="https://github.com/Kotlin/dataframe/tree/master/examples" toc-title="Examples"/>
 </instance-profile>

docs/StardustDocs/topics/Trobleshooting.md

@@ -0,0 +1,12 @@
+# Troubleshooting
+
+## Freezing when working with large page sizes
+
+Some operations in the UI may lag or freeze noticeably when working with large page sizes. Examples of these operations include sorting using the column header or navigating to the next page. This occurs because the UI attempts to render all the data at once, leading to excessive allocations and garbage collection (GC) pressure.
+
+To mitigate this issue, try the following:
+- Reduce the page size to a smaller value.
+- Increase the JVM heap size in the Kotlin Notebook Plugin settings.
+- Tune the JVM GC settings of IntelliJ IDEA.
+    - For example, adjust the `G1ReservePercent` parameter.
+    - Further tuning is possible. For more detailed guidance, refer to the [Java Garbage-First Garbage Collector Tuning manual](https://docs.oracle.com/en/java/javase/17/gctuning/garbage-first-garbage-collector-tuning.html#GUID-90E30ACA-8040-432E-B3A0-1E0440AB556A).

docs/StardustDocs/topics/Usage-with-Kotlin-Notebook-Plugin.md

@@ -0,0 +1,54 @@
+# Usage with Kotlin Notebook Plugin
+
+The [Kotlin Notebook Plugin for IntelliJ IDEA](https://plugins.jetbrains.com/plugin/16340-kotlin-notebook),
+combined with Kotlin DataFrame, offers powerful data analysis capabilities within an interactive environment.
+Here are the key features:
+
+### Visual Data Exploration
+**Page through your data**:
+The pagination feature lets you move through your data one page at a time, making it possible to view large datasets.
+
+**Sort by column with a single click**:
+You can sort any column with a click.
+This is a convenient alternative to using `sortBy` in separate cells.
+
+**Go straight to the data you need**:
+You can jump directly to a particular row or column if you want something specific.
+This makes working with large datasets more straightforward.
+<video src="https://github.com/user-attachments/assets/aeae1c79-9755-4558-bac4-420bf1331f39" controls></video>
+
+### Drill down into nested data
+When your data has multiple layers, like a table within a table,
+you can now click on a cell containing a nested table to view these details directly.
+This makes it easy to go deeper into your data and then return to where you were.
+<video src="https://github.com/user-attachments/assets/ef9509be-e19b-469c-9bad-0ce81eec36b0" controls></video>
+
+### Visualize multiple tables via tabs
+You can open and visualize multiple tables in separate tabs.
+This feature is tailored to those who need to compare, contrast, or monitor different datasets simultaneously.
+<video src="https://github.com/user-attachments/assets/51b7a6e3-0187-49b3-bf5e-0c4d60f8b769" controls></video>
+
+
+### Exporting to files
+
+You can export data directly from the dataframe into various file formats.
+This simplifies sharing and further analysis.
+The interface supports exporting data to JSON for web applications,
+CSV for spreadsheet tools, and XML for data interchange.
+<video src="https://github.com/user-attachments/assets/ec28c59a-1555-44ce-98f6-a60d8feae347" controls></video>
+
+
+### Convenient copying of data from tables
+You can click and drag to select the data you need,
+or you can use keyboard shortcuts for quicker selection
+and then copy what’s needed with a simple right-click or another shortcut.
+It’s designed to feel intuitive,
+like copying text from a document, but with the structure and format of your data preserved.
+<video src="https://github.com/user-attachments/assets/88e53dfb-361f-40f8-bffb-52a512cdd3cd" controls></video>
+
+
+To get started, ensure you have the latest version of the Kotlin Notebook Plugin installed in IntelliJ IDEA,
+and begin exploring your data using Kotlin DataFrame in your notebook cells.
+
+For more information on using the Kotlin Notebook Plugin,
+refer to the [official documentation](https://kotlinlang.org/docs/kotlin-notebook-overview.html).