fix(docs): make VitePress base path configurable for deploys#180
Merged
Conversation
PatrickRitchie
approved these changes
Jun 1, 2026
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
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.
Summary
Sets the VitePress
basefrom aDOCS_BASEenvironment variable (defaulting to/), wires the docs workflow to passDOCS_BASE: /MTConnect.NET/at build time, and adds a contributor-facing page that documents the docs-site build and the new variable. Fixes the rendering issue on https://trakhound.github.io/MTConnect.NET/ where the deployed page loaded without CSS or JavaScript because asset URLs were absolute-from-domain-root (/assets/...) instead of project-prefixed (/MTConnect.NET/assets/...).docs/.vitepress/config.ts: replace the commented-outbaseline withbase: process.env.DOCS_BASE ?? '/'. Localvitepress devandvitepress buildkeep the bare-root behavior whenDOCS_BASEis unset; CI and other deployment targets opt in by setting the variable..github/workflows/docs.yml: passDOCS_BASE: /MTConnect.NET/on the VitePress build step so the GitHub Pages deploy receives correctly-prefixed asset URLs.docs/development/docs-site.md: new contributor-facing page covering local dev, the production build, theDOCS_BASEenvironment variable (with a four-row table mapping deploy URLs tobasevalues), how CI sets the base, and the diagnostic symptoms of a base mismatch. Wired into the/development/sidebar indocs/.vitepress/config.ts.