Skip to content

Fix UI mention in quick start #11

Fix UI mention in quick start

Fix UI mention in quick start #11

Workflow file for this run

name: Docs CI
on:
push:
branches: [main]
paths:
- "docs/**"
pull_request:
branches: [main]
paths:
- "docs/**"
# Cancel in-progress runs for the same branch/PR to save resources
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
jobs:
format:
name: Format Check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Setup Node.js
uses: actions/setup-node@v6
with:
node-version: "22"
- name: Setup PNPM
uses: pnpm/action-setup@v4
with:
version: "10.11.0"
run_install: false
- name: Get pnpm store directory
id: pnpm-cache
shell: bash
run: |
echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
- name: Setup pnpm cache
uses: actions/cache@v4
with:
path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/docs/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-
- name: Install dependencies
working-directory: ./docs
run: pnpm install
- name: Check formatting
working-directory: ./docs
run: pnpm prettier --check .
build:
name: Validate Build
runs-on: ubuntu-latest
needs: [format]
steps:
- uses: actions/checkout@v6
- name: Setup Node.js
uses: actions/setup-node@v6
with:
node-version: "22"
- name: Setup PNPM
uses: pnpm/action-setup@v4
with:
version: "10.11.0"
run_install: false
- name: Get pnpm store directory
id: pnpm-cache
shell: bash
run: |
echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
- name: Setup pnpm cache
uses: actions/cache@v4
with:
path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/docs/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-
- name: Install dependencies
working-directory: ./docs
run: pnpm install
- name: Validate build
working-directory: ./docs
run: pnpm build:dry-run
vale-lint:
name: Vale lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: errata-ai/vale-action@v2.1.1
with:
files: "docs/src/content/"