fix(docs): repair Pages URLs/base for public project page#160
Closed
Roger-luo wants to merge 1 commit into
Closed
Conversation
The repo was open-sourced, moving GitHub Pages from the private random subdomain (served at root) to the public project page `https://queracomputing.github.io/ppvm/` (served under `/ppvm/`). The docs config still assumed the old root-served subdomain, so: - the README "Docs" badge + prose link 404'd (dead subdomain), and the badge image used malformed shields syntax (`docs-6437FF` rendered as a text badge, not a coloured pill); - the live docs page was unstyled/un-navigable — assets and nav links were emitted as `/_astro/…` and `/quickstart` (base `/`) instead of `/ppvm/…`, all 404 under the project page. Fixes: - README: point Docs badge + doc link at queracomputing.github.io/ppvm/, fix badge syntax to `docs-online-6437FF`, and collapse the two broken CI badges (rust-ci.yml / python-ci.yml don't exist) into one accurate `ci.yml` badge. - astro.config.mjs: default `site` → https://queracomputing.github.io and update the deploy-target comment block. - docs.yml: build with PPVM_BASE=/ppvm/ on main and /ppvm/pr-preview/pr-<N> on PRs, PPVM_SITE → queracomputing.github.io. Templates already derive links from `import.meta.env.BASE_URL`, so the correct build-time base repairs every asset and nav link. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Collaborator
Author
|
oh didn't realize this is already fixed |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Open-sourcing the repo moved GitHub Pages from the private random subdomain (
congenial-bassoon-l436wp3.pages.github.io, served at root) to the public project pagehttps://queracomputing.github.io/ppvm/(served under/ppvm/). The docs config still assumed the old root-served subdomain, breaking two things:1. README badges
HTTP 404;https://queracomputing.github.io/ppvm/returnsHTTP 200(and is the repo's GitHub-APIhomepage).badge/docs-6437FFrendered as a "docs | 6437FF" text badge instead of a coloured pill.rust-ci.yml,python-ci.yml). There is one workflow —ci.yml— running both the rust and python jobs.2. Live docs page broken
The site was built with
base=/(correct when the private repo served at the subdomain root), but the public project page serves under/ppvm/. Every emitted asset/nav link 404s. Verified on the live site:…/ppvm/_astro/…style asset/_astro/…→ 404…/quickstart…/ppvm/quickstartFix
README.md— Docs badge + prose link →https://queracomputing.github.io/ppvm/; badge syntax →docs-online-6437FF; collapse the two broken CI badges into one accurateci.ymlbadge.docs/astro.config.mjs— defaultsite→https://queracomputing.github.io; refresh the deploy-target comment block..github/workflows/docs.yml— build withPPVM_BASE=/ppvm/onmainand/ppvm/pr-preview/pr-<N>on PRs;PPVM_SITE→https://queracomputing.github.io.The docs templates already derive every link from
import.meta.env.BASE_URL, so setting the correct build-timebaserepairs all assets and navigation at once. Thepr-preview-actionumbrella-dir: pr-previewalready lands previews atgh-pages/pr-preview/pr-<N>/, which matches the new/ppvm/pr-preview/pr-<N>base.Verification
grepforimport.meta.env.BASE_URL(no hardcodedhref="/"in layouts/components)./ppvm/pr-preview/pr-<N>/and should render fully styled with working navigation.🤖 Generated with Claude Code