Repository navigation
Deploy documentation with GitHub Pages - #40
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
site/output without changing documentation content ormkdocs.ymlmainpages: writeandid-token: writepermissions to the deployment jobuv.lockand skip installing/building the Xaibo package and UI, which the docs build does not requireWhy
The previous workflow copied the generated site to a self-managed server over SSH. That server was compromised, so the documentation should no longer depend on a persistent host or SSH deployment credentials.
GitHub Pages can host the same static MkDocs output at the existing
xaibo.aiapex domain.Impact
Documentation sources and site configuration are unchanged. Once the one-time repository and DNS setup below is complete, merges affecting docs or their dependencies will publish automatically through GitHub Pages.
Validation
actionlint .github/workflows/docs.ymluv sync --frozen --no-install-projectuv run --no-sync mkdocs build --strictThe build retains one existing informational message:
tutorial/advanced-orchestration.mdlinks to an anchor that is not present inhow-to/index.md. It does not fail strict mode and is unrelated to this deployment change.One-time cutover after merge
xaibo.aifor the XpressAI organization, then set it as this repository's Pages custom domain.185.199.108.153185.199.109.153185.199.110.153185.199.111.153wwwvia CNAME toxpressai.github.io.