From d35c6e71a2fc624841fd3a383c1af05e8bb7d806 Mon Sep 17 00:00:00 2001 From: Tom Grobbe Date: Sun, 26 Jul 2026 11:34:38 +0200 Subject: [PATCH] docs(vMenu): update docs readme with accurate testing and deployment info --- docs/README.md | 39 ++++++++++++--------------------------- 1 file changed, 12 insertions(+), 27 deletions(-) diff --git a/docs/README.md b/docs/README.md index 5438a85d..88bb6bcc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,16 +1,16 @@ # vMenu documentation -The vMenu docs site — built with [Astro Starlight](https://starlight.astro.build/) -and a custom "cartoon" theme. Source lives here; the built site is published into +The vMenu docs site. Built with [Astro Starlight](https://starlight.astro.build/) +and a custom theme. Source lives here, the built site is published into the hub repo (`TomGrobbe/TomGrobbe.github.io`) and served at: -| URL | Content | -| --- | --- | -| `/vmenu/` | Landing page (Legacy + Enhanced) | -| `/vmenu/legacy/` | This documentation (Starlight) | -| `/vmenu/enhanced/` | Coming-soon placeholder | +| URL | Content | +| ------------------ | -------------------------------- | +| `/vmenu/` | Landing page (Legacy + Enhanced) | +| `/vmenu/legacy/` | This documentation (Starlight) | +| `/vmenu/enhanced/` | Coming-soon placeholder | -(Today under `wiki.vespura.com`, later `docs.vespura.com`.) +Published site is live at [docs.vespura.com/vmenu](https://docs.vespura.com/vmenu) ## Local development @@ -26,28 +26,13 @@ npm run build # production build into ./dist ## How it deploys `.github/workflows/docs.yml` builds the site and pushes the output into the hub -repo under a lowercase `vmenu/` folder. It runs on: +repo under a `vmenu/` folder. It runs on: -- pushes to `master` that touch `docs/**`, and -- the manual **Run workflow** button (Actions → *Deploy Docs*). +- pushes to `master` that touch `docs/**` -GitHub Pages serves a *project* site at the case-sensitive `//` path, so +GitHub Pages serves a _project_ site at the case-sensitive `//` path, so lowercase `/vmenu/` cannot come from this (`vMenu`) repo's own Pages. Instead the -docs are published into the hub site as a real lowercase folder. - -## One-time setup - -1. **Create a deploy token.** GitHub → *Settings → Developer settings → - Fine-grained personal access tokens*. Scope it to **only** the - `TomGrobbe/TomGrobbe.github.io` repository with **Contents: Read and write**. - (An SSH deploy key works too if you prefer.) - -2. **Add it as a secret** in this repo: *Settings → Secrets and variables → - Actions → New repository secret*, named **`HUB_DEPLOY_TOKEN`**. - -3. **Turn off this repo's own GitHub Pages** (*Settings → Pages → Source → None*), - since docs are served from the hub site, not from `vMenu`'s Pages. This avoids a - stale site lingering at the old `/vMenu/` path. +docs are published into the hub site as a lowercase folder, keeping the old docs url the same. The workflow adds a `.nojekyll` file to the hub automatically so Astro's `_astro/` asset folder is served correctly.