docs: add VitePress documentation site with GitHub Pages deployment

Rewrites all documentation with accurate project details (Fastify, port
1349, single-container Docker, all 33+ tools, full database schema).
Adds getting started guide and configuration reference. Updates help and
settings dialogs to link to the docs site.
This commit is contained in:
Siddharth Kumar Sah
2026-03-22 21:00:37 +08:00
parent 977b5f5ec0
commit 6668615750
16 changed files with 1457 additions and 6 deletions
+58
View File
@@ -0,0 +1,58 @@
name: AI Documentation Updater
on:
push:
branches:
- main
paths:
- 'apps/api/**'
- 'apps/web/**'
- 'packages/**'
jobs:
update-docs:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 2 # Fetch previous commit to get diff
- name: Setup pnpm
uses: pnpm/action-setup@v3
with:
version: 9
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
- name: Install dependencies
run: pnpm install
- name: Generate Diff
run: git diff HEAD^ HEAD > diff.patch
- name: Run Real AI Agent
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
run: |
echo "Running Claude to analyze changes and update docs..."
npx tsx apps/docs/scripts/update-docs.ts ./diff.patch
- name: Commit and Push Changes
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
git add apps/docs/
if ! git diff-index --quiet HEAD; then
git commit -m "docs: auto-updated by AI 🤖"
git push
else
echo "No documentation changes needed."
fi
+55
View File
@@ -0,0 +1,55 @@
name: Deploy Docs to GitHub Pages
on:
push:
branches: [main]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup pnpm
uses: pnpm/action-setup@v3
with:
version: 9
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
- name: Install dependencies
run: pnpm install
- name: Build Docs
run: pnpm --filter @stirling-image/docs docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: apps/docs/.vitepress/dist
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4