docs: VitePress docs site + Azure SWA deploy workflow#1676
Draft
mohnjiles wants to merge 49 commits into
Draft
Conversation
…ation formats, and precision types
Clarified VRAM requirements for image-generation setups, specifying minimums for older models and recommendations for current workflows.
Updated VRAM recommendations for image-generation setups and clarified specifications for basic models.
Updated the terminology from 'Workflows Overview' to 'Workflows Browser' for clarity.
- Document the Add Package screen, package detail view, version selection, hardware backend selection, installation pipeline steps, and the one-click install flow. - Update the first-launch "What You See Next" paragraph to link directly to the one-click install section
updated envars auto passed on windows rocm installs
Clarify that COMFYUI_ENABLE_MIOPEN is applicable for RDNA3 and newer.
Fact-checked the docs against the current codebase and fixed: - installation.md: VC++ Redistributable is auto-installed by SM during package install (WindowsPrerequisiteHelper); manual install reframed as a troubleshooting fallback - environment-variables.md: MIOPEN_SEARCH_CUTOFF auto-applied value is 1 (not 2); added MIOPEN_FIND_ENFORCE=1 to the auto-applied list; clarified RDNA3/RDNA3.5/RDNA4 gating incl. gfx1152/gfx1153 AOTriton exclusion; noted ComfyUI-Zluda's own auto-set vars and that the env-var editor overrides auto-applied defaults - inference/overview.md: video generation is three independent tabs (Wan T2V, Wan I2V, SVD I2V), not one mode; removed self-referential breadcrumb - supported-packages.md: ComfyUI-Zluda manual-setup cutoff is RX 6800 (matches the package's own disclaimer) - terminology.md: removed incorrect "Variable Auto Encoder" alternate name; corrected the "most SDXL checkpoints are VAE-baked" overclaim; framed CFG ranges as community rules of thumb; reduced repetitive phrasing throughout (wording only, no content changes) - overview.md: softened VRAM figures as dated rules of thumb - Converted links to not-yet-written pages into plain text with (planned) markers so nothing 404s; fixed typos (documentation, explanation, packages, Integration) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- getting-started/data-directory.md: what lives in the library folder, default locations per OS, portable mode (.sm-portable marker and precedence), changing it later (re-points, does not move data), and the FAT32/OneDrive warnings. All claims verified against SelectDataDirectoryViewModel, SettingsManager, and Compat. - package-manager/overview.md, advanced/overview.md, tips/overview.md: short section index pages so the "Section Overview" breadcrumbs on existing pages resolve; planned pages listed unlinked. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
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.
a/an agreement, missing colon + comma splice, duplicate "needed", GB's -> GBs, worfklows -> workflows, missing periods, 16GB -> 16 GB. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
mohnjiles
force-pushed
the
docs-site-scaffold
branch
from
2c54e1a to
63de3f1
Compare
- advanced/hardware-support.md: per-backend GPU support breakdown (CUDA incl. legacy/driver caveats, Windows AMD trichotomy of ROCm preview/ZLUDA/DirectML with gfx-arch gating, Linux ROCm, IPEX, MPS, CPU), all claims verified against BasePackage/WindowsRocmSupport/ GpuInfo/package classes; anchors #amd-rocm and #apple-silicon-mps preserved for existing references - troubleshooting/common-issues.md: symptom-first fixes for the recurring issue classes from the GitHub tracker (install failures, launch/update breakage, GPU/backend mismatches, Linux/macOS quirks, CivitAI browser, Inference connection/extension errors), plus log locations and bug-reporting guidance; app-behavior claims verified in code, known bugs flagged honestly instead of given fake fixes - README + advanced overview link the new pages Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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>
mohnjiles
force-pushed
the
docs-site-scaffold
branch
from
63de3f1 to
be68753
Compare
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
2 participants
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 with no restructuring: -docs/.vitepress/config.mts— README.md serves as the site index viarewrites; sidebar lists only pages that exist today; dead-link checking stays ON so a future PR that breaks a relative link fails the build. - Site tooling (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). Verified locally with the exact CI sequence (npm ci+vitepress build .): clean build, zero dead links, images render, relative links become proper site links. ## Stacking / dependencies — draft until these land 1. Docs content: this branch is stacked ondocs-review-fixups, so the diff currently includes the docs tree itself. The docs are landing upstream via NeuralFault''s docs branch (fixup PR: NeuralFault#3) — once that merges here, this branch will be rebased so it only adds the site scaffold. 2. Infra: the Azure Static Web App +docs.lykos.aiDNS is being added to lykos-infra (Terraform). After apply, the SWA deployment token needs to be added as theAZURE_STATIC_WEB_APPS_API_TOKEN_DOCSrepo secret. Local preview:cd docs && npm install && npm run docs:dev🤖 Generated with Claude CodeArchitecture note (2026-07-05)
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) once the current chain lands — don''t treat its location here as load-bearing. 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.