From 611549ecb67ebe59e6426f44872ce9158e7bc41f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 22 May 2026 18:00:09 +0000 Subject: [PATCH] Add local development documentation --- .../GettingStarted/LocalDevelopment/index.md | 60 +++++++++++++++++++ .../GettingStarted/LocalDevelopment/toc.yml | 3 + Documentation/GettingStarted/index.md | 6 ++ Documentation/GettingStarted/toc.yml | 6 ++ Documentation/index.md | 6 ++ Documentation/toc.yml | 6 ++ 6 files changed, 87 insertions(+) create mode 100644 Documentation/GettingStarted/LocalDevelopment/index.md create mode 100644 Documentation/GettingStarted/LocalDevelopment/toc.yml create mode 100644 Documentation/GettingStarted/index.md create mode 100644 Documentation/GettingStarted/toc.yml create mode 100644 Documentation/index.md create mode 100644 Documentation/toc.yml diff --git a/Documentation/GettingStarted/LocalDevelopment/index.md b/Documentation/GettingStarted/LocalDevelopment/index.md new file mode 100644 index 0000000..ad3c101 --- /dev/null +++ b/Documentation/GettingStarted/LocalDevelopment/index.md @@ -0,0 +1,60 @@ +# Local Development + +Use this tutorial to run Lens locally and connect it to your Arc backend. + +## Prerequisites + +- Node.js 20 or later +- npm +- Chrome or another Chromium-based browser +- A running Arc application on your machine + +## 1. Install dependencies + +From the repository root, install dependencies for the extension: + +```bash +cd Source +npm ci +``` + +You should see `added ... packages` with no install errors. + +## 2. Build the extension + +Build the extension bundle: + +```bash +npm run build +``` + +This generates `Source/dist/`, including `manifest.json`. + +## 3. Load Lens in your browser + +1. Open `chrome://extensions`. +2. Enable **Developer mode**. +3. Select **Load unpacked**. +4. Choose the `Source/dist` folder from this repository. + +The **Lens - Cratis Developer Tools** extension should now appear in your extension list. + +## 4. Set up Arc connection + +1. Open the extension options page from the extension details. +2. Set **Arc Base URL** to your local Arc host, for example `http://localhost:5000`. +3. Keep the default **Tenant Header Name** unless your app expects a different header. +4. Select **Save Settings**. + +Lens can now fetch command and query introspection metadata from your Arc application. + +## 5. Use watch mode while developing + +Run this in `Source/` during active development: + +```bash +npm run dev +``` + +Vite rebuilds the extension when you change source files. Reload the extension in `chrome://extensions` after each rebuild. + diff --git a/Documentation/GettingStarted/LocalDevelopment/toc.yml b/Documentation/GettingStarted/LocalDevelopment/toc.yml new file mode 100644 index 0000000..ba8945b --- /dev/null +++ b/Documentation/GettingStarted/LocalDevelopment/toc.yml @@ -0,0 +1,3 @@ +- name: Local Development + href: index.md + diff --git a/Documentation/GettingStarted/index.md b/Documentation/GettingStarted/index.md new file mode 100644 index 0000000..7c576f1 --- /dev/null +++ b/Documentation/GettingStarted/index.md @@ -0,0 +1,6 @@ +# Getting Started + +Start here to run Lens locally and connect it to your Arc application. + +- [Local Development](LocalDevelopment/index.md) + diff --git a/Documentation/GettingStarted/toc.yml b/Documentation/GettingStarted/toc.yml new file mode 100644 index 0000000..2bc1c10 --- /dev/null +++ b/Documentation/GettingStarted/toc.yml @@ -0,0 +1,6 @@ +- name: Getting Started + href: index.md + items: + - name: Local Development + href: LocalDevelopment/toc.yml + diff --git a/Documentation/index.md b/Documentation/index.md new file mode 100644 index 0000000..b06106d --- /dev/null +++ b/Documentation/index.md @@ -0,0 +1,6 @@ +# Lens Documentation + +This documentation helps you set up and use Lens during development. + +- [Getting Started](GettingStarted/index.md) + diff --git a/Documentation/toc.yml b/Documentation/toc.yml new file mode 100644 index 0000000..b177c8e --- /dev/null +++ b/Documentation/toc.yml @@ -0,0 +1,6 @@ +- name: Lens Documentation + href: index.md + items: + - name: Getting Started + href: GettingStarted/toc.yml +