chore: ci update + docs update

Author: tulayha

.github/workflows/unity-tests-run.yaml

@@ -213,6 +213,7 @@ jobs:
               conclusion === "success"
                 ? "Unity EditMode tests passed."
                 : "Unity EditMode tests failed.";
+            const runLink = `${context.serverUrl}/${owner}/${repo}/actions/runs/${context.runId}`;
             const reportLine =
               reportOutcome && reportOutcome !== "success"
                 ? "Test report failed to publish."
@@ -223,6 +224,7 @@ jobs:
               `**Status:** ${conclusion === "success" ? "passed" : "failed"}`,
               statusLine,
               reportLine,
+              `Run: ${runLink}`,
               "Manual rerun: `/run-unity-tests`",
             ].filter(Boolean).join("\n");
 

CONTRIBUTING.md

@@ -1,17 +1,22 @@
 # How to Contribute
 
 ## Local Setup
-Setting up the project locally is similar to any other Unity project:
+
+### Unity-only (most contributors)
+Use this if you are only editing C# code, assets, samples, or tests.
 1. Ensure you have [Unity 2022.3.23f1](https://unity.com/releases/editor/whats-new/2022.3.23) installed.
-2. Install [NodeJS](https://nodejs.org/en) on your system.
-3. Fork the repository and clone it to your local drive.
-4. To build the plugin, run these commands in your terminal:
+2. Fork the repository and clone it to your local drive.
+
+### JS bridge (only if you change the WebGL plugin)
+Node.js is only required to rebuild the WebGL JS bridge. The build step installs the upstream JS SDK and generates the `.jslib`/`.jspre` files used by Unity.
+1. Install [NodeJS](https://nodejs.org/en) on your system.
+2. Build the JS bridge:
    ```shell
    cd Tools/playroomkit-js
    npm install
    ```
-   This command will install the `upstream.sdk` and its dependencies. It also creates a `Playroom` folder inside `Assets/Plugins`, containing two files: a `.JSLIB` file and a `.JSPRE` file.
-5. Complete your setup by running `npm install` whenever changes are made to `Playroomkit/src/index.js`.
+   This installs the upstream SDK and builds the WebGL plugin into `Packages/com.playroomkit.sdk/Runtime/Plugins/Playroom` (the `.jslib` and `.jspre` files).
+3. Re-run `npm install` (or `npm run build`) only when `Tools/playroomkit-js/src/index.js` changes.
 
 ## Resources
 - User-facing Documentation: https://docs.joinplayroom.com/usage/unity
@@ -39,30 +44,25 @@ To implement a new feature available in the upstream SDK:
 The process for implementing fixes from the upstream SDK mirrors other feature implementations, typically done within the `index.js` file.
 
 ### Architecture
-This package follows this folder structure:
+This package follows this folder structure (UPM layout):
 ```
-PlayroomKit
-├── dependencies/
+Packages/com.playroomkit.sdk
+├── Assets/
 ├── Editor/
-├── Examples/
-├── modules/
-├── node_modules/
-├── Prefabs/
-├── src/
-└── Tests/
-└── package.json    
-└── package-lock.json
-└── Playroom.asmdef 
-└── PlayroomKit.cs  
-└── vite.config.js 
+├── Runtime/
+├── Samples~/
+├── Tests/
+├── package.json
+├── Playroom.asmdef
+└── PlayroomKit.cs
 ```
-The package also includes a custom WebGL template for Discord activities located in `Assets/WebGLTemplates`.
+The package also includes a custom WebGL template for Discord activities located in `Packages/com.playroomkit.sdk/Assets/WebGLTemplates`.
 
 #### Modules
 Playroomkit comes with many [modules](https://docs.joinplayroom.com/components) which help with speeding up development. Unity SDK builds on top of that and adds its own modules such as MockMode.
 The folder structure is something like this:
 ```
-modules
+Packages/com.playroomkit.sdk/Runtime/modules
 ├── Helpers/
 ├── Interfaces/
 ├── MockMode/
@@ -85,4 +85,17 @@ modules
 - **PlayroomkitDevManager.cs**: Manager script for choosing between local and browser mockmode, this is used in the `PlayroomMockManager` prefab.
 
 ## Tests
-Tests are located in the `Playroomkit/Tests` folder and are currently editor-only. Install Unity Test Runner to execute tests via the `Window/General/Test Runner` menu.
+Tests are located in `Packages/com.playroomkit.sdk/Tests/Editor` and are currently editor-only. Install Unity Test Runner to execute tests via the `Window/General/Test Runner` menu.
+
+## Samples
+Samples are distributed via the package and must be imported into your project to run them.
+1. Open `Window > Package Manager`.
+2. Select `PlayroomKit` in the list.
+3. In the `Samples` section, click `Import` on the sample you want to run.
+4. Open the imported sample scene from your project `Assets/` folder.
+
+### Syncing sample changes
+If the package sample content changes, re-import the sample from the same Package Manager screen (`Samples` section > `Reimport`).
+
+Do not edit the imported sample directly in `Assets/` if you want changes to persist upstream. The imported copy is not merged back into the package. If you must tweak something in an imported sample, also apply the same changes to the source sample under `Packages/com.playroomkit.sdk/Samples~` (or manually replace the updated files in the package sample).
+

README.md

@@ -20,6 +20,7 @@ This SDK is a wrapper over PlayroomKit JS. Currently, it only supports WebGL exp
 
 See [PlayroomKit Unity docs](https://docs.joinplayroom.com/usage/unity) on how to use this SDK in your Unity project.
 
+The SDK is distributed as a UPM package (not a `.unitypackage`). Source lives under `Packages/com.playroomkit.sdk`, and samples are under `Packages/com.playroomkit.sdk/Samples~`.
 
 This beta version of the SDK might undergo changes that could break compatibility with previous versions, even without a major version update. To ensure stability, it's advisable to fix the usage to a particular package version. By doing so, you'll consistently install the same version and avoid unexpected changes, unless you deliberately seek the latest updates.
 
@@ -32,28 +33,21 @@ This beta version of the SDK might undergo changes that could break compatibilit
 
 You can search for help, or ask the community, in our [Discord channel](https://discord.gg/HGkSRAD8).
 
-Found a bug, or want us to implement something? [Create an Issue](https://github.com/asadm/playroom-unity/issues/new) on GitHub.
+Found a bug, or want us to implement something? [Create an Issue](https://github.com/playroomkit/unity/issues/new) on GitHub.
 
 ### Creating a new release
 
-Tag and push the tag to create a new release. The tag should be in the format `v0.Y.Z`. For example, `v0.0.20`.
-
-```bash
-git tag v0.Y.Z
-git push origin --tags
-```
-
-This will create a draft release [on GitHub](https://github.com/asadm/playroom-unity/releases). Edit the release to add release notes and publish it.
+Releases are handled by release-please. Merges to `main` create or update a release PR; merging that PR cuts the tag, updates `CHANGELOG.md`, and publishes the GitHub release (the workflow also attaches the packed UPM artifact).
 
 ### Contribute code to this project
 
 Read [CONTRIBUTING.md](./CONTRIBUTING.md) for more information on how to contribute code to this project.
 
 ### Examples
 
-Example(s) of the SDK are in the [Examples](https://github.com/asadm/playroom-unity/tree/main/Assets/PlayroomKit/Examples) folder
+Example(s) of the SDK are in the [Samples](https://github.com/playroomkit/unity/tree/main/Packages/com.playroomkit.sdk/Samples~) folder
 
 <!-- End SDK Contribution -->
 
 ### Limitations
-Currently, there's no support for using the native platforms. We'd love to hear ideas and plans to implement PlayroomKit for Unity on native platforms. Please join [this Discord](https://discord.gg/uDHxeRYhRe) to discuss!
+Currently, there's no support for using the native platforms. We'd love to hear ideas and plans to implement PlayroomKit for Unity on native platforms. Please join [this Discord](https://discord.gg/uDHxeRYhRe) to discuss!