Merge branch 'main' into mason/vercel-marketplace-docs

Author: masnwilliams

apps/deploy.mdx

@@ -9,38 +9,74 @@ Once you deploy an app on Kernel, you can schedule its actions on a job or run t
 
 ## Deploy the app
 
+### From local directory
+
 Use our CLI from the root directory of your project:
 ```bash
-# entrypoint_file_name should be where you've defined your Kernel app
 kernel deploy <entrypoint_file_name>
 ```
 
+#### Notes
+
+- The `entrypoint_file_name` is the file name where you [defined](/apps/develop) your app.
+- Include a `.gitignore` file to exclude dependency folders like `node_modules` and `.venv`.
+
+### From GitHub
+
+You can deploy an app directly from a public or private GitHub repository using the Kernel CLI — no need to clone or manually push code.
+
+```bash
+kernel deploy github \
+  --url https://github.com/<owner>/<repo> \
+  --ref <branch|tag|commit> \
+  --entrypoint <path/to/entrypoint> \
+  [--path <optional/subdir>] \
+  [--github-token <token>] \
+  [--env KEY=value ...] \
+  [--env-file .env] \
+  [--version latest] \
+  [--force]
+```
+
+#### Notes
+- **`--path` vs `--entrypoint`:** Use `--path` to specify a subdirectory within the repo (useful for monorepos), and `--entrypoint` for the path to your app's entry file relative to that directory (or repo root if no `--path` is specified).
+- The CLI automatically downloads and extracts the GitHub source code and uploads your app for deployment.
+- For private repositories, provide a `--github-token` or set the `GITHUB_TOKEN` environment variable.
+
 ## Environment variables
 
 You can set environment variables for your app using the `--env` flag. For example:
 
 <CodeGroup>
-```bash Typescript/Javascript
+```bash Typescript/Javascript (inline)
 kernel deploy my_app.ts --env MY_ENV_VAR=my_value # Can add multiple env vars delimited by space
 ```
 
-```bash Python
+```bash Typescript/Javascript (from file)
+kernel deploy my_app.ts --env-file .env
+```
+
+```bash Python (inline)
 kernel deploy my_app.py --env MY_ENV_VAR=my_value # Can add multiple env vars delimited by space
 ```
+
+```bash Python (from file)
+kernel deploy my_app.py --env-file .env
+```
 </CodeGroup>
 
 ## Deployment notes
 
-- The `entrypoint_file_name` is the file name where you [defined](/apps/develop) your app.
-- **The entrypoint file and dependency manifest (`package.json` for JS/TS, `pyproject.toml` for Python) must both be in the root directory of your project.**
-- Include a `.gitignore` file to exclude dependency folders like `node_modules` and `.venv`.
+- **The dependency manifest (`package.json` for JS/TS, `pyproject.toml` for Python) must be present in the root directory of your project.**
+- View deployment logs using: `kernel deploy logs <deployment_id> --follow`
+- If you encounter a 500 error during deployment, verify that your entrypoint file name and extension are correct (e.g., `app.py` not `app` or `app.js`).
 - Kernel assumes the root directory contains at least this file structure:
 
 <CodeGroup>
 ```bash Typescript/Javascript
 project-root/
   ├─ .gitignore # Exclude dependency folders like node_modules
-  ├─ my_app.ts # Entrypoint file
+  ├─ my_app.ts # Entrypoint file (can be located in a subdirectory, e.g. src/my_app.ts)
   ├─ package.json
   ├─ tsconfig.json # If using TypeScript
   └─ bun.lock | package-lock.json | pnpm-lock.yaml # One of these lockfiles

browsers/live-view.mdx

@@ -15,6 +15,34 @@ To access the live view, visit the `browser_live_view_url` provided when you cre
 The `browser_live_view_url` supports additional query parameters to customize the live view:
 - `readOnly` (bool): when set to `true`, the view will be non-interactive.
 
+## Kiosk mode
+
+Kiosk mode provides a fullscreen live view experience without browser UI elements like the address bar and tabs. You can enable kiosk mode when creating a browser by setting the `kiosk_mode` parameter to `true`.
+
+<CodeGroup>
+
+```typescript Typescript/Javascript
+const kernelBrowser = await kernel.browsers.create({
+    viewport: {
+        width: 1920,
+        height: 1080
+    },
+    kiosk_mode: true
+});
+```
+
+```python Python
+kernel_browser = client.browsers.create(
+    viewport={
+        "width": 1920,
+        "height": 1080
+    },
+    kiosk_mode=True
+)
+```
+
+</CodeGroup>
+
 ## Browser persistence
 
  `browser_live_view_url` becomes invalid once the browser is [deleted](/browsers/termination) manually or via timeout.

browsers/viewport.mdx

@@ -51,6 +51,10 @@ kernel_browser_auto = client.browsers.create(
 
 </CodeGroup>
 
+<Note>
+The `refresh_rate` parameter only applies to live view sessions and is ignored for [headless](/browsers/headless) browsers.
+</Note>
+
 ## Supported viewport configurations
 
 Kernel supports specific viewport configurations. The server will reject unsupported combinations. When you provide width and height without specifying refresh_rate, it will be automatically determined if the dimensions match one of the supported resolutions exactly. The following resolutions are supported:
@@ -204,4 +208,4 @@ The server will reject any viewport configuration that doesn't exactly match one
 - Higher resolutions (like 2560x1440) may impact the performance and responsiveness of live view sessions
 - The viewport size affects how websites render, especially those with responsive designs
 - Screenshots taken from the browser will match the configured viewport dimensions
-- In [headless mode](/browsers/headless), the viewport configuration still applies for rendering and screenshots
+- In [headless mode](/browsers/headless), the viewport width and height still apply for rendering and screenshots, but the `refresh_rate` parameter is ignored