Skip to content

docs: update documentation source path references #9

docs: update documentation source path references

docs: update documentation source path references #9

Workflow file for this run

name: Docs
on:
pull_request:
branches: [main, dev]
paths:
- "docs-site/**"
- "docs/**"
- "README.md"
- ".github/workflows/docs.yml"
push:
branches: [main, dev]
paths:
- "docs-site/**"
- "docs/**"
- "README.md"
- ".github/workflows/docs.yml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
env:
DOCS_SITE_URL: https://recursivedev.github.io
DOCS_BASE: /ReCursor/
jobs:
build:
name: Build docs site
runs-on: ubuntu-latest
defaults:
run:
working-directory: docs-site
steps:
- uses: actions/checkout@v4
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: "22"
cache: npm
cache-dependency-path: docs-site/package-lock.json
- name: Install dependencies
run: npm ci
- name: Validate docs site
run: npm run check
- name: Upload static artifact
if: github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v3
with:
path: docs-site/dist
deploy:
name: Deploy docs site
if: github.event_name != 'pull_request' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev')
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Configure GitHub Pages
uses: actions/configure-pages@v5
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4