From efd74498660ddb546a2ca7b992b4680c13a8912f Mon Sep 17 00:00:00 2001 From: sjinks <7810770+sjinks@users.noreply.github.com> Date: Mon, 12 Aug 2024 10:05:31 +0000 Subject: [PATCH] docs: automated documentation update --- features/src/desktop-lite/README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 features/src/desktop-lite/README.md diff --git a/features/src/desktop-lite/README.md b/features/src/desktop-lite/README.md new file mode 100644 index 0000000..7bce0cb --- /dev/null +++ b/features/src/desktop-lite/README.md @@ -0,0 +1,27 @@ + +# Desktop Lite (desktop-lite) + +A lightweight desktop environment for development. + +## Example Usage + +```json +"features": { + "ghcr.io/Automattic/vip-codespaces/desktop-lite:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| enabled | Enable the Desktop Lite feature. | boolean | true | +| vnc_geometry | The geometry of the VNC server. | string | 1280x800 | +| vnc_password | The password for the VNC server. The password must be at least six characters long, and only the first eight characters are significant. | string | vscode | +| install-runit-service | Whether to install a runit service for the Desktop Lite feature. | boolean | true | + + + +--- + +_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/Automattic/vip-codespaces/blob/main/features/src/desktop-lite/devcontainer-feature.json). Add additional notes to a `NOTES.md`._