Set up Vitepress deployment (#7)

Author: LucaButBoring

.github/workflows/deploy.yml

@@ -0,0 +1,50 @@
+name: Deploy VitePress site to Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+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 Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci
+      - name: Build with VitePress
+        run: npm run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: .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

.gitignore

@@ -7,3 +7,5 @@ node_modules/
 *.tsbuildinfo
 dist/
 schema/**/generated/
+.vitepress/cache
+.vitepress/dist

.vitepress/config.mts

@@ -0,0 +1,52 @@
+import { defineConfig } from "vitepress";
+import { withMermaid } from "vitepress-plugin-mermaid";
+
+export default withMermaid(
+  defineConfig({
+    title: "MCP Tasks Extension",
+    description: "Documentation for the MCP Tasks extension",
+
+    head: [["link", { rel: "icon", href: "/mcp.png" }]],
+
+    themeConfig: {
+      outline: [2, 3],
+
+      nav: [
+        { text: "SEPs", link: "/seps/2663-tasks-extension" },
+        { text: "Specification", link: "/specification/draft/tasks" },
+      ],
+
+      sidebar: {
+        "specification/": [
+          {
+            text: "Specification",
+            items: [{ text: "Draft", link: "/specification/draft/tasks" }],
+          },
+        ],
+        "seps/": [
+          {
+            text: "SEPs",
+            items: [
+              { text: "SEP-1686: Tasks", link: "/seps/1686-tasks" },
+              {
+                text: "SEP-2663: Tasks Extension",
+                link: "/seps/2663-tasks-extension",
+              },
+            ],
+          },
+        ],
+      },
+
+      socialLinks: [
+        {
+          icon: "github",
+          link: "https://github.com/modelcontextprotocol/ext-tasks",
+        },
+      ],
+
+      search: {
+        provider: "local",
+      },
+    },
+  }),
+);

CONTRIBUTING.md

@@ -13,4 +13,4 @@ Please see the [MCP Contributing Guidelines](https://github.com/modelcontextprot
 ## License
 
 By contributing, you agree that your contributions will be licensed under the Apache License 2.0.
-See the [LICENSE](LICENSE) file for details.
+See the [LICENSE](https://github.com/modelcontextprotocol/ext-tasks/blob/main/LICENSE) file for details.

README.md

@@ -44,4 +44,4 @@ This repository follows the Model Context Protocol project policies:
 
 ## License
 
-This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.
+This project is licensed under the Apache License 2.0. See [LICENSE](https://github.com/modelcontextprotocol/ext-tasks/blob/main/LICENSE) for details.

docs/overview.md index.mddocs/overview.md renamed to index.md

@@ -1,10 +1,9 @@
 ---
 title: Overview
-group: Getting Started
 description: MCP Tasks lets servers return durable poll handles instead of blocking on long-running tool calls. Clients poll for progress, provide mid-flight input, and retrieve results after reconnecting.
 ---
 
-# MCP Tasks Overview
+# Overview
 
 MCP Tasks is an extension to the Model Context Protocol. Servers return a durable task handle instead of blocking on a long-running operation; clients poll for progress and retrieve the result when ready.
 
@@ -178,15 +177,15 @@ When a task needs client input, it transitions to `input_required` and the `task
 
 Each key in `inputRequests` is unique over the lifetime of a task. The server may accept partial responses; the task remains `input_required` until all arrive. Reads (`tasks/get`) and writes (`tasks/update`) are separate to keep reads idempotent and cacheable.
 
-See the [specification](./specification/draft/tasks.mdx) for the full `tasks/update` request shape and consistency semantics.
+See the [specification](./specification/draft/tasks) for the full `tasks/update` request shape and consistency semantics.
 
 ## Cancellation and Notifications
 
 Clients send `tasks/cancel` to signal cancellation intent. The server acks with an empty result — cancellation is cooperative, and the task may still reach a non-`cancelled` terminal status.
 
 Servers may also push status updates via `notifications/tasks`, which clients opt into through `subscriptions/listen`. Each notification carries the full task state, identical to a `tasks/get` response.
 
-See the [specification](./specification/draft/tasks.mdx) for details on both mechanisms.
+See the [specification](./specification/draft/tasks) for details on both mechanisms.
 
 ## Security
 
@@ -202,6 +201,6 @@ Task-augmented execution is currently supported for:
 
 ## Learn More
 
-- [Specification](./specification/draft/tasks.mdx) — Full protocol specification
-- [SEP-2663](../seps/2663-tasks-extension.md) — The proposal defining this extension
-- [Schema](../schema/) — TypeScript types and generated JSON Schema
+- [Specification](./specification/draft/tasks) — Full protocol specification
+- [SEP-2663](./seps/2663-tasks-extension.md) — The proposal defining this extension
+- [Schema](https://github.com/modelcontextprotocol/ext-tasks/tree/main/schema) — TypeScript types and generated JSON Schema