docs: VitePress docs site + Azure SWA deploy workflow#1676
Merged
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request establishes a comprehensive documentation suite for Stability Matrix using Vitepress, adding detailed guides on installation, package management, inference, advanced configuration, and terminology. The review feedback focuses on polishing the documentation by addressing minor typographical errors, grammatical slips, and formatting inconsistencies across several markdown files.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
2c54e1a to
63de3f1
Compare
Static docs site built from the existing docs/ tree, no restructuring: - docs/.vitepress/config.mts: README.md rewritten to site index, sidebar for existing pages only, dead-link checking kept on so broken relative links fail the build - Site tooling contained in docs/ (package.json, lockfile, gitignore) so the repo root stays .NET-only - .github/workflows/docs-site.yml: build + deploy to Azure Static Web Apps (AZURE_STATIC_WEB_APPS_API_TOKEN_DOCS secret) on docs/** pushes to main; build-check only on PRs Verified locally: npm ci + vitepress build passes with zero dead links. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
63de3f1 to
be68753
Compare
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- VitePress built-in local search (Ctrl+K) - "Edit this page on GitHub" links for community contributions - sitemap.xml generated for docs.lykos.ai - lastUpdated page footers (deploy job now checks out full history) - staticwebapp.config.json rewrites Azure SWA 404s to the VitePress 404 page Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
ionite34
previously approved these changes
Jul 14, 2026
Per team discussion: prefix all URLs from day one so the planned move to a multi-product docs repo (SM + Chat + Bench) never breaks hotlinks or SEO — the future migration becomes a pure code move. - rewrites map every page under stability-matrix/, README.md as the section index - bare site root 302s to /stability-matrix/ via staticwebapp.config.json (replaced by a product landing page at migration) - markdown hook normalizes content links targeting README to directory-index form; VitePress emits relative hrefs verbatim, so ./../README rendered as a README.html that does not exist in the built output (latent 404 even at root config — dev middleware masked it, and the dead-link checker resolves in source space so it never flagged it) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
ionite34
previously approved these changes
Jul 14, 2026
The default title link targets the bare site root, which only resolves through the Azure SWA redirect — link straight to /stability-matrix/ so it works in local preview too and skips the redirect hop in prod. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
ionite34
approved these changes
Jul 14, 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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
VitePress static site scaffold for docs.lykos.ai, built from the
docs/tree (landed via #1685) with no content restructuring:/stability-matrix/from day one — per team discussion, so the planned move to a multi-product docs repo (SM + Chat + Bench) never breaks hotlinks or SEO. The bare site root 302s to/stability-matrix/(replaced by a product landing page at migration).README.mdserves as the section index viarewrites.sitemap.xml, and last-updated footers on every page. Dead-link checking stays ON so a future PR that breaks a relative link fails the build.README(e.g../../README) to directory-index form. VitePress emits relative hrefs verbatim, so those links pointed at aREADME.htmlthat doesn't exist in the built output — a latent 404 that the dev server masked and the dead-link checker (which resolves in source space) never flagged. The content itself is correct on GitHub and in the in-app viewer (feat: in-app documentation viewer #1677); the mismatch is purely this site's README→index rewrite, so the fix lives in the site shell rather than the content.docs/public/staticwebapp.config.json— root redirect + Azure SWA serves the VitePress 404 page instead of its default.package.json, lockfile,.gitignore) contained insidedocs/so the repo root stays .NET-only..github/workflows/docs-site.yml— ondocs/**pushes to main:npm ci+vitepress build+ deploy to Azure Static Web Apps (AZURE_STATIC_WEB_APPS_API_TOKEN_DOCSsecret). PRs touchingdocs/**get a build-check job only (no deploy). The deploy job checks out full history so last-updated dates are accurate.Verified locally with the exact CI sequence (
npm ci+vitepress build .): clean build, zero dead links, and browser-tested — search, edit links, section index at/stability-matrix/, and the README breadcrumbs all confirmed working against the built output.Local preview:
cd docs && npm install && npm run docs:dev(then open/stability-matrix/; the root redirect only exists on Azure)Remaining runbook
Merge Feat: Initial Documentation #1685 (docs content)✅ merged; main merged back into this branch, PR diff is now scaffold-only (6 files).envs/docs-prod):terraform applycreates the Azure SWA (Free tier), thedocs.lykos.aiCloudflare CNAME (unproxied), and auto-wires the SWA deploy token into this repo'sAZURE_STATIC_WEB_APPS_API_TOKEN_DOCSsecret viaci.tf./302s to/stability-matrix/, home page renders, Ctrl+K search finds "rocm", a deep page (e.g./stability-matrix/advanced/hardware-support), a section-overview "back to home" breadcrumb, a garbage URL shows the VitePress 404,/sitemap.xmlresolves.docs/is onmainnow, so its "docs not available yet" state is already gone; it just needs the GUI smoke test.Architecture note (2026-07-05, updated 2026-07-13)
Per team discussion: this site shell (
.vitepress/config + deploy workflow) is expected to migrate to a separate public multi-product docs repo (SM + Chat + Bench sections, path-prefixed:/stability-matrix/,/chat/,/crabbench/) once a second product has docs to publish — tracked on the roadmap board. With URLs prefixed from day one, that migration is a pure code move: no redirects, no SEO impact, no broken hotlinks. SM markdown content stays in this repo either way (community contributions + docs-with-code PRs); the docs repo will pull it at build time. At migration, theAZURE_STATIC_WEB_APPS_API_TOKEN_DOCSsecret moves to the docs repo (one-variable change in lykos-infraenvs/docs-prod), leaving no Azure secrets in this repo. Docs-only CI skip for the requiredbuildcheck is being handled separately.🤖 Generated with Claude Code