Merge pull request #62 from huanshankeji/copilot/fix-1e12ff10-bb36-42db-8915-7914dc2c7a25

Add comprehensive .github/copilot-instructions.md for repository onboarding

Author: ShreckYe

.github/copilot-instructions.md

@@ -0,0 +1,195 @@
+# Copilot Instructions for Compose Multiplatform HTML Unified
+
+## Repository Overview
+
+**Compose Multiplatform HTML Unified** is a Kotlin Multiplatform library that provides unified Compose Multiplatform wrappers of common and Material Design APIs for both **rendering-based Compose UI** (Android, desktop JVM, iOS, web Kotlin/Wasm) and **DOM-based Compose HTML**. This library was previously named "Compose Multiplatform Material".
+
+### Repository Statistics
+- **Size**: Medium-large multiplatform project with ~15 modules
+- **Language**: Kotlin (multiplatform)
+- **Build System**: Gradle with Kotlin DSL
+- **Target Platforms**: JVM, Android, iOS, JS (DOM), Wasm-JS (Canvas)
+- **Key Dependencies**: Compose Multiplatform, Kobweb Silk, Material Web Components
+
+## Build Instructions and Environment Setup
+
+### Prerequisites
+- **JDK 17**: Required (as specified in GitHub Actions workflows)
+- **Network Access**: Required for initial builds to download Android Gradle Plugin and other dependencies
+- **Gradle 9.1.0**: Automatically handled by wrapper
+
+**IMPORTANT**: Initial builds require internet access for dependency resolution. Once dependencies are cached, subsequent builds can use `--offline` flag if needed.
+
+**IMPORTANT**: If the project uses snapshot dependencies of other `com.huanshankeji` libraries, especially in a branch other than `main` such as `dev`, refer to the setup instructions at <https://github.com/huanshankeji/.github/blob/main/dev-instructions.md#about-snapshot-dependencies-of-our-library-projects>.
+
+### Build Commands (In Order)
+
+#### 1. Basic Project Setup
+```bash
+./gradlew --version  # Verify Gradle 9.1.0 and JDK 17
+```
+
+#### 2. Publishing to Local Maven (Primary Development Command)
+```bash
+./gradlew publishToMavenLocal
+```
+**Important**: Always run `publishToMavenLocal` first when making changes, as mentioned in CONTRIBUTING.md. This ensures libraries compile correctly and validates the build process.
+
+#### 3. Running Tests and Checks (Essential Commands - validated and working)
+```bash
+./gradlew check
+```
+**Note**: The project has "limited number of tests" according to CONTRIBUTING.md, but this validates what exists.
+
+#### 4. Building Demo Applications
+```bash
+# Build the side-by-side demo (used for GitHub Pages)
+./gradlew :compose-multiplatform-html-unified-demo:sideBySideBrowserDistribution
+
+# Individual platform builds
+./gradlew jsBrowserDistribution    # JS DOM version
+./gradlew wasmJsBrowserDistribution  # Wasm-JS Canvas version
+```
+
+### Build Configuration Details
+
+#### Memory Requirements
+- **Gradle JVM**: 2GB memory allocated via `org.gradle.jvmargs=-Xmx2G` in gradle.properties (required for Wasm compilation)
+
+#### Common Build Issues and Workarounds
+
+1. **Network Connectivity**: Initial builds require internet access for Android Gradle Plugin (8.11.2) and other dependencies. If build fails with network errors, ensure internet connectivity.
+
+2. **Memory Issues**: If Wasm compilation fails with OOM, the memory is already optimized in gradle.properties.
+
+3. **Kotlin/JS Store**: The `kotlin-js-store` directory may be generated during JS builds - this should be committed when updated automatically by Gradle commands.
+
+4. **Gradle Daemon**: May timeout on first runs. Use `--no-daemon` flag if needed: `./gradlew check --no-daemon`
+
+### Build Timing and Known Issues
+
+**Timing Expectations**:
+- First build: 5-10 minutes (includes dependency resolution and Wasm compilation)
+- Subsequent builds: 1-3 minutes
+- `publishToMavenLocal`: 3-5 minutes
+- `check` execution: 2-5 minutes (limited tests)
+- Demo builds: 2-4 minutes
+
+**Common Issues**:
+- **Wasm Compilation**: Requires 2GB+ heap memory (pre-configured in gradle.properties)
+- **Network Dependencies**: Initial builds require internet access for dependency resolution
+- **Platform-specific builds**: Some targets may be disabled on certain OS (use `--continue` flag)
+
+## Project Architecture and Layout
+
+### Module Structure
+```
+├── common/                    # Core APIs, layouts, modifiers (foundation equivalent)
+├── material-icons-core/       # Icon system core
+├── material2/                 # Material Design 2 components  
+├── material3/                 # Material Design 3 components
+├── navigation/               # Navigation support (experimental)
+├── lifecycle-viewmodel/      # ViewModel support (experimental)
+├── demo/                     # Demonstration application
+└── buildSrc/                 # Build configuration and dependencies
+```
+
+### Key Configuration Files
+- **buildSrc/src/main/kotlin/VersionsAndDependencies.kt**: All dependency versions
+- **buildSrc/src/main/kotlin/common-conventions.gradle.kts**: Shared build configuration
+- **buildSrc/src/main/kotlin/lib-conventions.gradle.kts**: Library-specific configuration
+- **gradle.properties**: JVM memory settings for Gradle (increase if OOM occurs) and Kotlin MPP configuration
+- **settings.gradle.kts**: Project structure and repository configuration
+
+### Source Set Structure (Per Module)
+```
+src/
+├── commonMain/           # Shared APIs across all platforms
+├── composeUiMain/        # Compose UI targets (JVM, Android, iOS, Wasm)
+├── composeUiExceptAndroidMain/  # Compose UI excluding Android
+├── androidMain/          # Android-specific implementations
+├── jsMain/               # JS DOM implementations (Kobweb/HTML)
+├── jvmMain/              # Desktop JVM implementations
+└── iosMain/              # iOS-specific implementations
+```
+
+### Dependencies and External Integration
+
+#### Required External Repositories
+```kotlin
+repositories {
+    mavenCentral()
+    google()  // For Android components
+}
+```
+
+**Note**: All dependencies are available from standard repositories. If working with snapshot dependencies of other `com.huanshankeji` libraries, additional setup may be required as per organization instructions.
+
+#### Key Dependencies
+- **Kotlin**: 2.2.20 with Compose Compiler
+- **Compose Multiplatform**: 1.9.0
+- **Android Gradle Plugin**: 8.11.2  
+- **Kobweb**: 0.23.3 (now on Maven Central)
+- **Compose HTML Material**: 0.4.1-SNAPSHOT
+- **Binary Compatibility Validator**: 0.18.1 (enabled)
+
+### Platform-Specific Implementation Patterns
+
+#### Compose UI Platforms (Android, JVM, iOS, Wasm)
+- Delegate directly to official `androidx.compose` APIs
+- Located in `composeUiMain` source sets
+
+#### JS DOM Platform  
+- Built on **Kobweb Silk** (provides Modifier system and layouts)
+- Uses **Material Web Components** via Compose HTML Material
+- Located in `jsMain` source sets
+- Requires CSS imports for Material Icons
+
+### Development Patterns and Conventions
+
+#### API Structure
+- **Common APIs**: Defined in `commonMain`, expect/actual pattern for platform differences
+- **Ext Components**: Components in `ext` packages don't follow androidx.compose APIs exactly but provide more idiomatic platform-specific wrappers
+- **Parameter Naming**: Parameters with "JsDom" or "ComposeUi" suffixes are platform-specific
+
+#### Code Quality and Validation
+- **Binary Compatibility**: Enforced via org.jetbrains.kotlinx.binary-compatibility-validator plugin
+- **Limited Testing**: Project acknowledges "limited number of tests"
+
+#### Architecture Notes
+- **Multi-module**: Each feature area is a separate Gradle subproject
+- **Expect/Actual Pattern**: Platform-specific implementations using Kotlin Multiplatform patterns
+- **Convention Plugins**: Custom build logic in `buildSrc` for consistency across modules
+- **Target Platforms**: Sophisticated setup targeting 6+ platforms with different implementation strategies
+
+### Root Directory Files
+```
+.gitignore              # Standard exclusions plus .kotlin, local.properties  
+build.gradle.kts        # Root build file with binary compatibility validator
+CHANGELOG.md            # Detailed version history with breaking changes
+CODE_OF_CONDUCT.md      # Standard code of conduct
+CONTRIBUTING.md         # Development guidelines and contribution process
+gradle.properties       # Memory settings and Kotlin configuration
+LEGACY_README.md        # Previous project name reference
+LICENSE                 # Apache 2.0 license
+README.md               # Comprehensive API documentation and usage guide
+settings.gradle.kts     # Project structure and dependency management
+```
+
+## Validation Steps for Changes
+
+1. **Build Validation**: Run `./gradlew build` or `./gradlew publishToMavenLocal` to ensure libraries compile
+2. **Test Validation**: Run `./gradlew check` to validate existing tests pass  
+3. **Demo Validation**: Build demo with `./gradlew :compose-multiplatform-html-unified-demo:sideBySideBrowserDistribution`
+4. **CI Simulation**: Test on multiple platforms if possible (the CI runs on Ubuntu, macOS, Windows)
+5. **Binary Compatibility**: The kotlinx binary compatibility validator will catch API breaks
+
+## Important Notes for Agents
+
+- **Trust These Instructions**: Only perform additional searches if information here is incomplete or incorrect
+- **Network Dependency**: Initial builds require internet access for dependency resolution
+- **Memory Requirements**: Ensure adequate memory for Wasm compilation (2GB JVM heap configured)
+- **Limited Test Coverage**: Don't expect comprehensive test suites - focus on build and demo validation
+- **Platform Complexity**: This is a sophisticated multiplatform project with 6+ target platforms and complex expect/actual patterns
+
+**Trust these instructions**: This information has been validated through actual command execution and file inspection. Only search for additional information if these instructions are incomplete or found to be incorrect.