Skip to content

[pull] master from TomGrobbe:master #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pull merged 1 commit into from
Jul 26, 2026
Merged

[pull] master from TomGrobbe:master #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 12 additions & 27 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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 `/<RepoName>/` path, so
GitHub Pages serves a _project_ site at the case-sensitive `/<RepoName>/` 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.
Loading