Repository navigation
Publish the documentation as a VitePress site on GitHub Pages - #8
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.
Summary
Moves the long-form documentation out of the README into a VitePress site under
docs/, deployed to the GitHub Pages root. The hosted web client moves from the Pages root to/tibeepost/app/. The copy the TV serves athttp://TV_IP:8090/is unchanged.Changes
docs/: VitePress 1.6 site with a home page, Guide (getting started, TV settings, web client, troubleshooting), API (HTTP reference with the full field table, notification behavior) and Development pages. Green brand theme matching the TV app, local search, edit links, dead-link checking.pages.yml: builds the client withVITE_BASE=/tibeepost/app/, builds the docs, places the client under/app/of the docs output and deploys the combined folder. Also triggers ondocs/**.ci.yml: newdocsjob that builds the site so a broken cross-page link fails the PR.README.md: trimmed to an overview with install, the permission command, the curl quickstart and a link per docs page. The obsolete Branches section is gone.client/README.md: hosted URL andVITE_BASEexample point at/tibeepost/app/.Testing
cd docs && npm run buildpasses with zero dead links.VITE_BASE=/tibeepost/app/, copied it into the docs output, served the combined folder withvitepress previewand loaded/tibeepost/,/tibeepost/api/,/tibeepost/guide/web-clientand/tibeepost/app/in Chromium: all four render, the client shows its Compose, Devices, History and curl tabs, and no request other than the browser's implicit favicon probe returns 404.tv/app/build.gradle.ktsstill builds the bundled copy withVITE_BASE=/.After merging, the Pages deploy should be confirmed at https://zorenkonte.github.io/tibeepost/ and https://zorenkonte.github.io/tibeepost/app/.
Checklist
cd tv && ./gradlew testDebugUnitTest assembleDebugpasses (no TV files changed; CI runs it)cd client && npm run lint && npm run buildpasses (no client source changed; build verified under the new base)