Merge pull request #1236 from Kotlin/run_configs

Run configs

Author: AndreiKingsley

.gitignore

@@ -1,5 +1,7 @@
 # Default ignored files
 .idea
+!.idea/runConfigurations
+!.idea/runConfigurations/*.xml
 !.idea/externalDependencies.xml
 !.idea/vcs.xml
 .gradle

.idea/runConfigurations/Build_Docs_Website.xml

@@ -12,6 +12,32 @@ and included in the [StardustDocs/d.tree](./StardustDocs/d.tree) file.
 
 Images all README files can be stored in [docs/imgs](./imgs).
 
+## Running the Documentation Website Locally
+
+⚠️ IFrames are not displayed when using the Writerside plugin preview. To view them correctly, you need to run the website locally.
+
+### Option 1: Using IntelliJ IDEA Configurations
+
+> Requires: `unzip` utility and **Python 3** installed in the environment. May not work properly on Windows.
+
+1. Run the `Build Docs Website` configuration.
+2. Run the `Run Docs Website Locally` configuration.
+3. Open [http://localhost:8000/home.html](http://localhost:8000/home.html) in your browser.
+4. Shut down the server with Ctrl+C or close the terminal window.
+
+### Option 2: Manual Steps
+
+1. Go to `Writerside > DataFrame(d) > Export To > Build Docs Website` or find Writerside web archive build in IDEA configuration.
+2. Unzip the archive located at: `./build/ws/webHelpD2-all.zip`
+3. Start a local web server in the extracted folder (e.g., using Python or `http-server` utility):
+   ```bash
+   python3 -m http.server
+   # or
+   http-server
+   ```
+4. Open [http://localhost:8000/home.html](http://localhost:8000/home.html) in your browser.
+5. Shut down the server with Ctrl+C or close the terminal window.
+
 ### Explainer dataframes
 `@TransformDataFrameExpressions` annotated test functions generate sample
 dataframe HTML files that can be used as iFrames on the documentation website.

.idea/runConfigurations/Run_Docs_Website_Locally.xml

@@ -7,6 +7,6 @@ and they are copied over to Markdown files in [docs/StardustDocs/topics](../docs
 by [Korro](https://github.com/devcrocod/korro).
 
 This module might be merged with [:core](../core): [Issue #898](https://github.com/Kotlin/dataframe/issues/898).
-
-See https://github.com/Kotlin/kandy/blob/samples_util/util/kandy-samples-utils/README.md for details of
-the Writerside docs generation.
+ 
+Uses Kandy samples util.
+See https://github.com/Kotlin/kandy/blob/samples_util/util/kandy-samples-utils/README.md for more details.