Skip to content

feat: VitePress GitHub Pages documentation site in ASD-STE100 - #59

Merged
spelech merged 7 commits into
mainfrom
feature/vitepress-docs
Sep 18, 2026
Merged

spelech merged 7 commits into
mainfrom
feature/vitepress-docs

Conversation

@spelech

@spelech spelech commented Sep 18, 2026

Copy link
Copy Markdown
Owner

Summary

This PR introduces the official VitePress documentation site deployed via GitHub Pages (.github/workflows/deploy-pages.yml) for Local LLM Server Manager. All user guides are authored following ASD-STE100 (Simplified Technical English) principles to ensure maximum clarity and accessibility for everyday users, while 100% of internal technical guides, architecture documents, and agent specifications are preserved under docs/technical/.

Key Changes

  • VitePress Foundation: Integrated VitePress 1.6.4 with local client-side offline search, clean URLs, dark theme, and scripts (docs:dev, docs:build, docs:preview).
  • GitHub Pages CI/CD: Added .github/workflows/deploy-pages.yml targeting docs/.vitepress/dist on pushes to main.
  • ASD-STE100 User Guides:
    • Getting Started: Requirements, Windows/Linux installation, first-time configuration, quickstart, and troubleshooting.
    • Engines & Models: Telemetry, VRAM Orchestrator, Ollama, SD Forge, ComfyUI, Kokoro TTS, and model hubs (Hugging Face GGUF / CivitAI).
    • Multimodal Studio: FLUX/SDXL image creation, Wan 2.2 / LTX video synthesis & player, Kokoro/YuE audio synthesis & waveform viewer, TRELLIS/Hunyuan 3D mesh & WebGL canvas.
    • AI & MCP: Zero-local-VRAM AI Chat Assistant, Model Context Protocol (MCP) server endpoints & tool catalog, and living prompt templates.
  • Preserved Technical Documentation: Architecture, development guide, SRS requirements matrix, Windows process validation, test coverage benchmarks, and assistant internals organized under docs/technical/.
  • Standards: Added docs/standards/ste-100.md defining writing rules for contributors.

Verification

pm run docs:build: 0 errors, all pages rendered successfully in 3.04s.

pm run lint: 0 errors.

px tsc --noEmit: 0 errors.

@spelech
spelech merged commit fe5bc1a into main Sep 18, 2026
2 checks passed
@spelech
spelech deleted the feature/vitepress-docs branch September 18, 2026 22:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant