From d825e5d6262d3a8125be1e3f2ef5e57eb8bd981e Mon Sep 17 00:00:00 2001 From: Federico Jaramillo Martinez Date: Mon, 15 Jun 2026 23:16:52 +0200 Subject: [PATCH] docs: use extensionless canonical URLs --- README.md | 4 ++-- docs/404.html | 20 ++++++++-------- docs/faq.html | 26 ++++++++++---------- docs/index.html | 34 +++++++++++++------------- docs/install.html | 24 +++++++++---------- docs/machines.html | 28 +++++++++++----------- docs/plugins.html | 28 +++++++++++----------- docs/plugins.md | 6 ++--- docs/remote-first.html | 26 ++++++++++---------- docs/sitemap.xml | 10 ++++---- vite.config.ts | 54 +++++++++++++++++++++++------------------- 11 files changed, 132 insertions(+), 128 deletions(-) diff --git a/README.md b/README.md index 21165bc..2ccad3c 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,7 @@ PI WEB keeps its own state intentionally small: ## Machine federation -The Machines section lets one PI WEB instance act as a gateway to other PI WEB runtimes. Register a remote machine from **Actions → Add Machine** with the remote PI WEB base URL, for example a URL reachable over NetBird, Tailscale, WireGuard, an SSH tunnel, or a trusted reverse proxy. The browser continues talking to the local PI WEB origin; project, workspace, file, git, session, activity, and terminal HTTP/WebSocket traffic is proxied server-to-server. See the [Fleet guide](https://pi-web.dev/machines.html) for setup, trust model, and troubleshooting details. +The Machines section lets one PI WEB instance act as a gateway to other PI WEB runtimes. Register a remote machine from **Actions → Add Machine** with the remote PI WEB base URL, for example a URL reachable over NetBird, Tailscale, WireGuard, an SSH tunnel, or a trusted reverse proxy. The browser continues talking to the local PI WEB origin; project, workspace, file, git, session, activity, and terminal HTTP/WebSocket traffic is proxied server-to-server. See the [Fleet guide](https://pi-web.dev/machines) for setup, trust model, and troubleshooting details. Remote model-provider credentials and OAuth state stay on the target machine. API-key provider configuration can be proxied, but OAuth login should be completed by opening the remote PI WEB directly. Register remote machines only when you trust the endpoint and the network path: adding a machine gives this PI WEB server permission to contact that URL with the optional bearer token you configured. @@ -122,7 +122,7 @@ A useful prompt for AI agents: ```text Build a PI WEB plugin for this project. Goal: . -Before coding, read https://pi-web.dev/plugins.html and https://pi-web.dev/plugins.md. +Before coding, read https://pi-web.dev/plugins and https://pi-web.dev/plugins.md. Create it under ~/.pi-web/plugins/ using the documented PI WEB v1 plugin API. Validate with /pi-web-plugins/manifest.json and explain reload/debug steps. Do not modify PI WEB itself. diff --git a/docs/404.html b/docs/404.html index 2636de0..2f313ac 100644 --- a/docs/404.html +++ b/docs/404.html @@ -9,7 +9,7 @@ - + @@ -37,11 +37,11 @@ PI WEB
- Remote-first - Fleet - Install - Plugins - FAQ + Remote-first + Fleet + Install + Plugins + FAQ
@@ -88,10 +88,10 @@
PI WEB · remote control for persistent Pi Coding Agent sessions.
- Fleet - Install - Plugins - FAQ + Fleet + Install + Plugins + FAQ npm
diff --git a/docs/faq.html b/docs/faq.html index ed7b3d3..1742a7d 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -8,7 +8,7 @@ name="description" content="Troubleshoot PI WEB, the web UI for Pi Coding Agent, including install, PATH, services, remote access, and runtime issues." /> - + @@ -16,7 +16,7 @@ property="og:description" content="Fix common PI WEB install, service, PATH, remote access, and session issues." /> - + @@ -47,11 +47,11 @@ PI WEB
- Remote-first - Fleet - Install - Plugins - FAQ + Remote-first + Fleet + Install + Plugins + FAQ
@@ -238,7 +238,7 @@
  • Remote plugins are trusted browser code and only appear while that machine is selected.
  • If the remote reports offline, check that the gateway server can reach the remote URL and try Actions → Refresh Selected Machine.
    • -

    Read the fleet guide →

    +

    Read the fleet guide →

    diff --git a/docs/index.html b/docs/index.html index f03b266..cb4805d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -63,11 +63,11 @@ PI WEB
    - Remote-first - Fleet - Install - Plugins - FAQ + Remote-first + Fleet + Install + Plugins + FAQ
    @@ -115,7 +115,7 @@

    Install in minutes - Read the docs + Read the docs
    Persistentsessions survive browser disconnects
    @@ -217,7 +217,7 @@
    - Read the remote-first philosophy + Read the remote-first philosophy
    @@ -280,8 +280,8 @@
  • Open the local URL, or tunnel it from a remote machine.
    • - Complete installation guide - Troubleshooting FAQ + Complete installation guide + Troubleshooting FAQ
    @@ -307,7 +307,7 @@ Use pi-web install where a supported per-user service manager is available. WSL works with the installer when systemd is enabled; otherwise use the manual run path.

    - Read compatibility notes → + Read compatibility notes →

    Local UI plugins?

    @@ -315,7 +315,7 @@ Ask AI agents to add trusted local UI plugins from ~/.pi-web/plugins without rebuilding or restarting the session daemon.

    - Build a plugin → + Build a plugin →

    Node or tools not found?

    @@ -323,7 +323,7 @@ Services run login shells. If tools work in your interactive terminal but not in PI WEB, fix PATH in your login shell startup files and run the doctor command.

    - Fix PATH issues → + Fix PATH issues →
    @@ -333,11 +333,11 @@
    PI WEB · web UI for persistent Pi Coding Agent sessions.
    - Remote-first - Fleet - Install - Plugins - FAQ + Remote-first + Fleet + Install + Plugins + FAQ npm
    diff --git a/docs/install.html b/docs/install.html index 5fd5136..cfddc18 100644 --- a/docs/install.html +++ b/docs/install.html @@ -8,7 +8,7 @@ name="description" content="Install PI WEB, the web UI for Pi Coding Agent, on Linux, macOS, or Windows WSL with persistent user services." /> - + @@ -16,7 +16,7 @@ property="og:description" content="Install PI WEB with npm, Pi, or manual service commands and keep Pi Coding Agent sessions running." /> - + @@ -47,11 +47,11 @@ PI WEB
    - Remote-first - Fleet - Install - Plugins - FAQ + Remote-first + Fleet + Install + Plugins + FAQ
    @@ -232,7 +232,7 @@ remote runtime.

    - Read the fleet guide + Read the fleet guide
    @@ -332,10 +332,10 @@ PI WEB docs
    Home - Remote-first - Fleet - Plugins - FAQ + Remote-first + Fleet + Plugins + FAQ GitHub
    diff --git a/docs/machines.html b/docs/machines.html index 231f4f7..4d7005e 100644 --- a/docs/machines.html +++ b/docs/machines.html @@ -8,7 +8,7 @@ name="description" content="Connect trusted PI WEB runtimes through machine federation so one web UI can supervise local and remote projects, sessions, files, git state, terminals, and plugins." /> - + @@ -16,7 +16,7 @@ property="og:description" content="Use one PI WEB instance to reach trusted local and remote Pi Coding Agent machines." /> - + @@ -47,11 +47,11 @@ PI WEB
    - Remote-first - Fleet - Install - Plugins - FAQ + Remote-first + Fleet + Install + Plugins + FAQ
    @@ -244,7 +244,7 @@ PI WEB gateway you opened Remote plugins are still trusted browser-side code. Only federate machines whose PI WEB plugins you are comfortable loading in the browser.

    -

    Read the remote machine plugin notes →

    +

    Read the remote machine plugin notes →

    @@ -273,8 +273,8 @@ PI WEB gateway you opened
  • Check gateway logs with pi-web logs for proxy timeouts or upstream errors.
    • - Review remote access setup - Read remote machine FAQ + Review remote access setup + Read remote machine FAQ
    @@ -287,10 +287,10 @@ PI WEB gateway you opened PI WEB fleet
    Home - Remote-first - Install - Plugins - FAQ + Remote-first + Install + Plugins + FAQ GitHub
    diff --git a/docs/plugins.html b/docs/plugins.html index c7f351c..53a2936 100644 --- a/docs/plugins.html +++ b/docs/plugins.html @@ -8,7 +8,7 @@ name="description" content="Use built-in PI WEB plugins and develop trusted local UI plugins for the Pi Coding Agent web UI." /> - + @@ -16,7 +16,7 @@ property="og:description" content="Customize PI WEB with trusted browser-side plugins for actions, workspace panels, labels, terminals, and files." /> - + @@ -47,11 +47,11 @@ PI WEB
    - Remote-first - Fleet - Install - Plugins - FAQ + Remote-first + Fleet + Install + Plugins + FAQ
    @@ -144,7 +144,7 @@ 
    Build a PI WEB plugin for this project.
 Goal: <describe the UI behavior>.
 Before coding, read the PI WEB plugin docs:
-https://pi-web.dev/plugins.html
+https://pi-web.dev/plugins
 Full API reference:
 https://pi-web.dev/plugins.md
 Create it as a local plugin under ~/.pi-web/plugins/<plugin-id>.
@@ -159,7 +159,7 @@ Do not modify PI WEB itself.
    Improve the PI WEB plugin at <path>.
 Before coding, read the PI WEB plugin docs:
-https://pi-web.dev/plugins.html
+https://pi-web.dev/plugins
 Full API reference:
 https://pi-web.dev/plugins.md
 Keep the plugin compatible with the documented v1 API.
@@ -322,7 +322,7 @@ After editing, check the manifest endpoint and browser-console failure cases.
               
    Remote machine plugins
    
               
    
-                With machine federation, PI WEB also loads discovered plugins from the selected
+                With machine federation, PI WEB also loads discovered plugins from the selected
                 remote machine. Remote plugins are trusted browser-side code like local plugins, but their actions,
                 workspace panels, and workspace labels only appear while that machine is selected.
               
    
@@ -427,10 +427,10 @@ After editing, check the manifest endpoint and browser-console failure cases.PI WEB plugin docs
         
    
           Home
-          Remote-first
-          Fleet
-          Install
-          FAQ
+          Remote-first
+          Fleet
+          Install
+          FAQ
           GitHub
    diff --git a/docs/plugins.md b/docs/plugins.md index 0743670..e201051 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -42,7 +42,7 @@ Copy-paste prompt for creating a plugin: Build a PI WEB plugin for this project. Goal: . Before coding, read the PI WEB plugin docs: -https://pi-web.dev/plugins.html +https://pi-web.dev/plugins Full API reference: https://pi-web.dev/plugins.md Create it as a local plugin under ~/.pi-web/plugins/. @@ -56,7 +56,7 @@ Copy-paste prompt for modifying a plugin: ```text Improve the PI WEB plugin at . Before coding, read the PI WEB plugin docs: -https://pi-web.dev/plugins.html +https://pi-web.dev/plugins Full API reference: https://pi-web.dev/plugins.md Keep the plugin compatible with the documented v1 API. @@ -131,7 +131,7 @@ Reload the PI WEB browser tab. PI WEB serves plugin modules with an mtime-based ## Remote machine plugins -When [machine federation](https://pi-web.dev/machines.html) is enabled, PI WEB also loads discovered plugins from the selected remote machine. Remote plugins are trusted browser-side code like local plugins, but their contributions are machine-scoped: +When [machine federation](https://pi-web.dev/machines) is enabled, PI WEB also loads discovered plugins from the selected remote machine. Remote plugins are trusted browser-side code like local plugins, but their contributions are machine-scoped: - actions, workspace panels, and workspace labels only appear while that machine is selected; - plugin file and terminal helpers run against that machine; diff --git a/docs/remote-first.html b/docs/remote-first.html index d04b442..4943dce 100644 --- a/docs/remote-first.html +++ b/docs/remote-first.html @@ -8,7 +8,7 @@ name="description" content="Why PI WEB keeps Pi Coding Agent sessions running outside your device while any browser becomes a web UI for supervision and review." /> - + @@ -16,7 +16,7 @@ property="og:description" content="Run Pi Coding Agent where work can persist, then supervise sessions from any device with PI WEB." /> - + @@ -47,11 +47,11 @@ PI WEB
    - Remote-first - Fleet - Install - Plugins - FAQ + Remote-first + Fleet + Install + Plugins + FAQ
    @@ -190,8 +190,8 @@ keep working even when the laptop is gone.
    - Install PI WEB - Laptop or server FAQ + Install PI WEB + Laptop or server FAQ
    @@ -204,10 +204,10 @@ PI WEB · remote-first control for persistent AI agents.
    Home - Fleet - Install - Plugins - FAQ + Fleet + Install + Plugins + FAQ GitHub
    diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 3c66312..6913ebc 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -1,9 +1,9 @@ https://pi-web.dev/ - https://pi-web.dev/remote-first.html - https://pi-web.dev/machines.html - https://pi-web.dev/install.html - https://pi-web.dev/plugins.html - https://pi-web.dev/faq.html + https://pi-web.dev/remote-first + https://pi-web.dev/machines + https://pi-web.dev/install + https://pi-web.dev/plugins + https://pi-web.dev/faq diff --git a/vite.config.ts b/vite.config.ts index ae5d5f4..2fc150a 100644 --- a/vite.config.ts +++ b/vite.config.ts @@ -19,7 +19,9 @@ const contentTypes: Record = { ".md": "text/markdown; charset=utf-8", ".png": "image/png", ".svg": "image/svg+xml", + ".txt": "text/plain; charset=utf-8", ".webm": "video/webm", + ".xml": "application/xml; charset=utf-8", }; type MiddlewareNext = (error?: unknown) => void; @@ -45,33 +47,35 @@ async function serveDevDocs(request: IncomingMessage, response: ServerResponse, const relativePath = decodeURIComponent(url.pathname.slice(docsPrefix.length + 1)) || "index.html"; const requestedPath = relativePath.endsWith("/") ? join(relativePath, "index.html") : relativePath; - const filePath = resolve(docsRoot, requestedPath); - if (filePath !== docsRoot && !filePath.startsWith(`${docsRoot}${sep}`)) { - response.statusCode = 403; - response.end("Forbidden"); - return; + const candidatePaths = extname(requestedPath) === "" ? [requestedPath, `${requestedPath}.html`] : [requestedPath]; + + for (const candidatePath of candidatePaths) { + const filePath = resolve(docsRoot, candidatePath); + if (filePath !== docsRoot && !filePath.startsWith(`${docsRoot}${sep}`)) { + response.statusCode = 403; + response.end("Forbidden"); + return; + } + + try { + const fileStat = await stat(filePath); + if (!fileStat.isFile()) continue; + + response.statusCode = 200; + response.setHeader("Content-Type", contentTypes[extname(filePath)] ?? "application/octet-stream"); + response.setHeader("Cache-Control", "no-store"); + createReadStream(filePath).pipe(response); + return; + } catch (error) { + const code = error instanceof Error && "code" in error ? error.code : undefined; + if (code === "ENOENT") continue; + next(error); + return; + } } - try { - const fileStat = await stat(filePath); - if (!fileStat.isFile()) { - response.statusCode = 404; - response.end("Not found"); - return; - } - response.statusCode = 200; - response.setHeader("Content-Type", contentTypes[extname(filePath)] ?? "application/octet-stream"); - response.setHeader("Cache-Control", "no-store"); - createReadStream(filePath).pipe(response); - } catch (error) { - const code = error instanceof Error && "code" in error ? error.code : undefined; - if (code === "ENOENT") { - response.statusCode = 404; - response.end("Not found"); - return; - } - next(error); - } + response.statusCode = 404; + response.end("Not found"); } function devDocsPlugin(): Plugin {