docs(Sky): Condense README with benefit-focused content

NikolaRHristov · NikolaRHristov · commit b42fcc5550d1 · 2026-04-04T10:19:25.000+03:00
Rewrite the Sky README from verbose documentation into concise, scannable sections highlighting core architecture principles, what Sky does, ecosystem integration, and development setup. Remove redundant sections (Key Features, Deep Dive, Interaction Flow, System Diagram) while retaining essential information. Replace SimpleIcons CDN with self-hosted SVG badges at editor.land.

The condensed format improves readability and aligns with the project-wide documentation direction targeting user outcomes over implementation details.
diff --git a/README.md b/README.md
@@ -37,150 +37,34 @@ Land
 </tr>
 </table>
 
----
-
-# **Sky** 🌌
-
-The UI Component Layer for Land 🏞️
-
-[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](https://github.com/CodeEditorLand/Land/tree/Current/LICENSE)
-[![NPM Version](https://img.shields.io/npm/v/@codeeditorland/sky.svg)](https://www.npmjs.com/package/@codeeditorland/sky)
-[<img src="https://cdn.simpleicons.org/astro/BC52EE" width="14" alt="Astro" />](https://astro.build/)&#x2001;[![Astro Version](https://img.shields.io/badge/Astro-5.17.3-blue.svg)](https://www.npmjs.com/package/astro)
-[<img src="https://cdn.simpleicons.org/effect" width="14" alt="Effect-TS" />](https://effect.website/)&#x2001;[![Effect Version](https://img.shields.io/badge/Effect-3.x-blueviolet.svg)](https://www.npmjs.com/package/effect)
-
-Welcome to **Sky**, the declarative **UI component layer** of the **Land Code
-Editor**. Built with the **Astro** framework, **Sky** renders the user interface
-including the editor, side bar, activity bar, status bar, and panels. It
-operates within the **Tauri** webview alongside `Wind`, consuming state and
-services from the `Wind` service layer to display and manage the editor's visual
-presentation.
-
-**What Sky gives you:**
-
-1. **The editor you see.** Every panel, sidebar, tab bar, and status bar is an
-   Astro component. Change a component, and Tauri hot-reloads it instantly.
-2. **Multiple workbench layouts.** Three approaches (A1-A3) for different
-   deployment scenarios: full desktop, embedded, and minimal.
-3. **State from Wind.** Sky consumes Wind's Effect-TS services. UI state is
-   always consistent, always typed, always reactive.
-4. **SPA routing in a webview.** Page transitions happen client-side inside
-   Tauri's webview. No full-page reloads, no navigation flicker.
 
 ---
 
-## Key Features 🔐
-
-- **Astro-Based Component Architecture:** Leverages Astro's component islands
-  architecture for efficient, content-driven UI development with zero JavaScript
-  by default and selective hydration for interactive components.
-- **VSCode UI Compatibility:** Provides multiple workbench approaches that load
-  and integrate VSCode's core UI components from `@codeeditorland/output`,
-  ensuring a high-fidelity editor experience.
-- **Wind Service Layer Integration:** Seamlessly consumes `Wind`'s Effect-TS
-  services for file operations, dialogs, configuration, and state management,
-  enabling a clean separation between UI and business logic.
-- **Tauri Webview Integration:** Runs within the Tauri webview, communicating
-  with the `Mountain` backend through Tauri's IPC mechanism and event system for
-  native OS capabilities.
-- **Flexible Workbench Variants:** Supports multiple workbench approaches
-  through environment-based selection:
-    - **A1 (Browser/BrowserProxy):** Browser-based workbench with optional
-      service proxy.
-    - **A2 (Mountain - RECOMMENDED):** Browser workbench with Mountain-backed
-      providers.
-    - **A3 (Electron):** Electron workbench with polyfills for VSCode.
-- **Component Modularity:** Organized into Pages (routes), Workbenches
-  (components), and Workbench Implementations (BrowserProxy/, Electron/
-  subdirectories) for clear separation of concerns.
-- **Responsive Design:** Built with CSS and Astro's styling capabilities to
-  ensure the editor interface adapts to different window sizes and user
-  preferences.
-
----
+# **Sky**&#x2001;🌌
 
-## Core Architecture Principles 🏗️
+> **VS Code's UI is tightly coupled to Electron's renderer process. Changing a panel requires understanding the full Chromium lifecycle. Hot-reload means restarting the entire renderer.**
 
-| Principle           | Description                                                                                                                     | Key Components Involved                                                                     |
-| :------------------ | :------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------ |
-| **Compatibility**   | Provide high-fidelity VSCode UI rendering to maximize compatibility with VSCode extensions and workflows.                       | `Workbench/*`, `Workbench/BrowserProxy/*`, `Workbench/Electron/*`, `@codeeditorland/output` |
-| **Modularity**      | Components (pages, workbenches, layouts) are organized into distinct, cohesive modules for clarity and maintainability.         | `pages/*`, `Workbench/*`, `Workbench/BrowserProxy/*`, `Workbench/Electron/*`, `Function/*`  |
-| **Performance**     | Leverage Astro's static generation and selective hydration to minimize JavaScript payload and maximize rendering performance.   | Astro build system, Component Islands                                                       |
-| **Integration**     | Seamlessly connect with `Wind` services and `Mountain` backend through Tauri events and IPC for state updates and user actions. | `Install`, `Bootstrap`, Tauri event listeners                                               |
-| **Maintainability** | Clear separation between UI components and business logic, with UI state driven by `Wind` services for predictable data flow.   | Service consumption pattern, Event-driven updates                                           |
+_"Every panel is a component. Instant hot-reload."_
 
----
-
-## Deep Dive & Component Breakdown 🔬
+[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](https://github.com/CodeEditorLand/Land/tree/Current/LICENSE)
+[![NPM Version](https://img.shields.io/npm/v/@codeeditorland/sky.svg)](https://www.npmjs.com/package/@codeeditorland/sky)
+[<img src="https://editor.land/Image/Astro.svg" width="14" alt="Astro" />](https://astro.build/)&#x2001;[![Astro Version](https://img.shields.io/badge/Astro-5.17.3-blue.svg)](https://www.npmjs.com/package/astro)
+[<img src="https://editor.land/Image/EffectTS.svg" width="14" alt="Effect-TS" />](https://effect.website/)&#x2001;[![Effect Version](https://img.shields.io/badge/Effect-3.x-blueviolet.svg)](https://www.npmjs.com/package/effect)
 
-To understand how `Sky`'s internal components interact — including the Astro
-configuration, workbench approaches, and integration with `Wind` — please refer
-to the detailed technical breakdown in the `Documentation/` directory or the
-source code comments in [`astro.config.ts`](astro.config.ts) and workbench
-components. The source files explain the role of each workbench variant, page
-routing, and the build process for bundling Wind modules.
+Sky provides three workbench layouts (full desktop, embedded, minimal) built from Astro components. Tauri reloads Sky instantly on any component change. High-fidelity VS Code UI compatibility with a significantly smaller footprint. No Electron renderer magic. Web components rendered by the OS's own WebView.
 
 ---
 
-## `Sky` in the Land Ecosystem 🌌 + 🏞️
-
-| Component              | Role & Key Responsibilities                                                                                                             |
-| :--------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
-| **Astro Components**   | The declarative UI building blocks that compose the editor interface, from activity bar to status bar.                                  |
-| **Tauri Webview**      | The runtime environment where `Sky` executes, providing access to Tauri APIs and OS integration.                                        |
-| **Wind Integration**   | Consumes `Wind`'s Effect-TS services for file operations, dialogs, configuration, and state management.                                 |
-| **Workbench Variants** | Multiple approaches (A1-A3) for loading and integrating VSCode's core editor components: Browser, Mountain (recommended), and Electron. |
-| **Page Routing**       | Manages navigation between index (default), Browser, BrowserProxy, Electron, Mountain, and Isolation pages.                             |
-| **Event Handling**     | Listens for Tauri events from `Mountain` to update UI state (terminal output, SCM updates, etc.).                                       |
-
----
+## What It Does&#x2001;🔐
 
-## Interaction Flow: Rendering UI from Wind State 🔄
-
-Here's a step-by-step example of how `Sky` renders the UI based on `Wind`'s
-state:
-
-1. **Page Load:** User navigates to `/`, which loads `index.astro` (the default
-   workbench entry point).
-2. **Workbench Selection:** The page reads environment variables to determine
-   which workbench to load:
-    - `Mountain=true` → Loads the recommended A2: Mountain workbench
-      (`Workbench/Mountain.astro`)
-    - `Electron=true` → Loads A3: Electron workbench
-      (`Workbench/Electron/Layout.astro`)
-    - `BrowserProxy=true` → Loads A1: Browser Proxy workbench
-      (`Workbench/BrowserProxy/Layout.astro`)
-    - `Browser=true` → Loads A1: Browser workbench (`Workbench/Browser.astro`)
-    - Default → Loads `Workbench/Default.astro`
-
-3. **Wind Bootstrap:** The workbench imports and executes `@codeeditorland/wind`
-   bootstrap, which:
-    - Installs the `Preload.ts` environment shim (providing `window.vscode`
-      globals)
-    - Initializes Effect-TS runtime and service layers
-    - Establishes Tauri IPC connection to `Mountain`
-
-4. **Service Consumption:** `Sky` components subscribe to `Wind` services:
-    - `StatusBarService` → Updates status bar items
-    - `ActivityBarService` → Manages activity bar state
-    - `FileSystemService` → Provides file tree data to sidebar
-
-5. **Event Listening:** `Sky` listens for Tauri events from `Mountain`:
-    - `sky://terminal/data` → Renders terminal output in panel
-    - `sky://scm/update-group` → Updates source control view
-    - `sky://configuration/changed` → Re-renders affected UI components
-
-6. **User Interaction:** When user clicks "Open File":
-    - `Sky` component calls `Wind`'s `DialogService.showOpenDialog()`
-    - `Wind` invokes Tauri's native dialog via `@tauri-apps/plugin-dialog`
-    - Selected file URI is returned through `Wind` to `Sky`
-    - `Sky` updates the editor component to display the opened file
+- **Three workbench layouts.** Full desktop, embedded, and minimal deployments from the same component set.
+- **Instant hot-reload.** Tauri reloads Sky immediately on any component change during development.
+- **VS Code UI compatibility.** Panels, sidebars, tab bars, and status bars match the VS Code UX.
+- **OS-native rendering.** Components rendered by WKWebView/WebView2/WebKitGTK, not bundled Chromium.
 
 ---
 
-## System Architecture Diagram 🏗️
-
-This diagram illustrates how `Sky` sits within the Tauri webview, consuming
-`Wind` services and rendering the UI.
+## In the Ecosystem&#x2001;🌌 + 🏞️
 
 ```mermaid
 graph LR
@@ -229,10 +113,7 @@ WorkbenchImpl -- Loads --> VSCodeComponents
 
 ---
 
-## Project Structure Overview 🗺️
-
-The `Sky` repository is organized to separate concerns between pages,
-workbenches, and components:
+## Project Structure&#x2001;🗺️
 
 ```
 Sky/
@@ -282,132 +163,30 @@ Sky/
 
 ---
 
-## Getting Started 🚀
-
-### Installation 📥
-
-To add `Sky` to your project workspace:
-
-```sh
-pnpm add @codeeditorland/sky
-```
-
-**Key Dependencies:**
-
-- `astro`: `5.17.3`
-- `@codeeditorland/wind`: `0.0.1` (service layer)
-- `@codeeditorland/common`: `0.0.6` (Rust core bindings)
-- `@codeeditorland/output`: `0.0.1` (VSCode output bundle)
-- `@codeeditorland/worker`: `0.0.1` (Web worker implementations)
-- `@playform/build`, `@playform/compress`, `@playform/inline`: Build utilities
-- `deepmerge-ts`, `dotenv`, `typescript`, `vite`, `zod`: Development utilities
-
-**Note:** `@tauri-apps/api` is accessed transitively through the `Wind` service
-layer rather than as a direct dependency.
-
-### Usage Pattern 🚀
-
-`Sky` is primarily used through its page routes and workbench components:
-
-1. **Configure Astro:** Set up your `astro.config.ts` to include `Sky`'s pages
-   and resolve `Wind` modules:
-
-    ```ts
-    import { defineConfig } from "astro/config";
-
-    export default defineConfig({
-    	root: "./Source",
-    	outDir: "../Target",
-    	publicDir: "../Static",
-    	vite: {
-    		resolve: {
-    			alias: {
-    				"@codeeditorland/wind": "/path/to/wind/dist",
-    			},
-    		},
-    	},
-    });
-    ```
-
-2. **Build the Project:** Run the Astro build to generate static files:
-
-    ```sh
-    pnpm run build
-    ```
-
-3. **Integrate with Tauri:** Configure your `tauri.config.json` to serve `Sky`'s
-   built output:
-
-    ```json
-    {
-    	"tauri": {
-    		"windows": [
-    			{
-    				"url": "/app",
-    				"file://": "./Target"
-    			}
-    		]
-    	}
-    }
-    ```
-
-4. **Use Workbench Components:** Import and use workbench variants in your
-   pages:
-
-    ```astro
-    ---
-    // Source/pages/index.astro (or create a custom page)
-    import MountainWorkbench from "../Workbench/Mountain.astro";
-    ---
-
-    <html>
-    	<body>
-    		<MountainWorkbench />
-    	</body>
-    </html>
-    ```
-
-Alternatively, set environment variables to select the workbench at runtime:
-
-```bash
-# Use Mountain workbench (A2 - RECOMMENDED)
-Mountain=true pnpm run Run
-
-# Use Electron workbench (A3)
-Electron=true pnpm run Run
-
-# Use Browser Proxy workbench (A1)
-BrowserProxy=true pnpm run Run
-```
-
----
-
-## License ⚖️
+## Development&#x2001;🛠️
 
-This project is released into the public domain under the **Creative Commons CC0
-Universal** license.
-
-You are free to use, modify, distribute, and build upon this work for any
-purpose, without any restrictions. For the full legal text, see the
-[`LICENSE`](https://github.com/CodeEditorLand/Land/tree/Current/LICENSE) file.
+Sky is a component of the Land workspace. Follow the
+[Land Repository](https://github.com/CodeEditorLand/Land) instructions to
+build and run.
 
 ---
 
-## Changelog 📜
+## License&#x2001;⚖️
 
-Stay updated with our progress! See [`CHANGELOG.md`](../../CHANGELOG.md) for a
-history of changes specific to **Sky**.
+CC0 1.0 Universal. Public domain. No restrictions.
+[LICENSE](https://github.com/CodeEditorLand/Sky/tree/Current/LICENSE)
 
 ---
 
-
 ## See Also
 
+- [Sky Documentation](https://editor.land/Doc/sky)
 - [Architecture Overview](https://editor.land/Doc/architecture)
+- [Why Tauri](https://editor.land/Doc/why-tauri)
 - [Wind](https://github.com/CodeEditorLand/Wind)
-- [Cocoon](https://github.com/CodeEditorLand/Cocoon)
 - [Mountain](https://github.com/CodeEditorLand/Mountain)
 
+
 ## Funding & Acknowledgements 🙏🏻
 
 **Sky** is a core element of the **Land** ecosystem. This project is funded
