Repository navigation
Add user docs site (VitePress) with GitHub Pages deploy - #1
Merged
Merged
Conversation
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.
What & why
PSflix has no user-facing documentation. This adds a maintained docs site for players — covering sign-in, browsing/favorites, playing in the browser, save states, memory cards, and environment-specific troubleshooting (cross-origin isolation, the known Chromium audio quirk) — and publishes it automatically to GitHub Pages.
Part of the
add-user-docs-siteOpenSpec change (planning artifacts included).What's in it
user-docs/— self-contained VitePress 1.6.4 project (ownpackage.json/package-lock, root install untouched), Obsidian Console dark-only branding (Inter,#121414bg, PS-blue/teal brand ramp), local search, 7 content sections.github/workflows/docs.yml— builds on PRs touchinguser-docs/**; on master pushes composes the Pages artifact with docs underdocs/(site root reserved for the future landing page) and deploys viadeploy-pages.workflow_dispatchsupported for first deployuser-docsadded to ESLint ignores; VitePressdist/cachegitignored. No app code changesdocker-release-pipelinechangeHow to test
npm run lint && npm run typecheck(Node 20, per CI)