Add minimal docs

.github/workflows/deploy-preview..yml

@@ -0,0 +1,29 @@
+name: Deploy PR previews
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+
+concurrency: preview-${{ github.ref }}
+
+jobs:
+  deploy-preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.x
+      - uses: astral-sh/setup-uv@v7
+      - run: uv run generate_schema_docs.py --all
+      - run: uv run zensical build --clean
+
+      - name: Deploy preview
+        uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: ./site/
+          preview-branch: gh-pages

.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+name: build documentation
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+concurrency:
+  group: pages
+  cancel-in-progress: false
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/configure-pages@v5
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.x
+      - uses: astral-sh/setup-uv@v7
+      - run: uv run generate_schema_docs.py --all
+      - run: uv run zensical build --clean
+
+      - uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: site # The folder the action should deploy.

.github/workflows/pre-commit.yml

@@ -7,6 +7,6 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-      - uses: pre-commit/action@v3.0.0
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+      - uses: j178/prek-action@v1

.gitignore

@@ -1 +1,3 @@
 *.DS_Store
+.cache
+site

README.md

@@ -14,21 +14,30 @@ Each folder contains the schema (`schema.json`) and a `tests` folder with test c
 ### Prettier formatting
 
 We use [Prettier](https://prettier.io/) to format all files in this repository.
-We use [pre-commit](https://pre-commit.com/) to run Prettier on all files before committing.
+We use [prek](https://prek.j178.dev/) to run Prettier on all files before committing.
 
 To install the pre-commit hooks, run the following command:
 
 ```bash
-pre-commit install
+prek install
 ```
 
 To run Prettier on all files, run the following command:
 
 ```bash
-pre-commit run --all-files
+prek run --all-files
 ```
 
-This is done automatically when committing.
+### Building Documentation
+
+Serve documentation locally:
+
+```bash
+uv sync --dev
+uv run zensical serve
+```
+
+Then open `http://127.0.0.1:8000` in your browser.
 
 ### Testing schemas
 

docs/index.md

@@ -0,0 +1,15 @@
+---
+hide:
+  - toc
+---
+
+# Introduction
+
+Welcome to the Nextflow Schemas documentation. This repository contains JSON schemas used by Nextflow for validating pipeline inputs and plugin specifications.
+
+## Overview
+
+This repository provides two main schemas:
+
+- **[Pipeline Schema](schemas/pipeline/v1/schema)**: Validates Nextflow pipeline input specifications, including parameter definitions, validation rules, and parameter grouping
+- **[Plugin Schema](schemas/plugin/v1/schema)**: Validates Nextflow plugin specifications, including configuration scopes and function definitions