feat(docs): Docusaurus site scaffold + Pages CI (PR #1/3)

.github/workflows/docs.yml

@@ -0,0 +1,63 @@
+name: Docs
+
+on:
+  pull_request:
+    branches: [main]
+    paths:
+      - "website/**"
+      - ".github/workflows/docs.yml"
+  push:
+    branches: [main]
+    paths:
+      - "website/**"
+      - ".github/workflows/docs.yml"
+  workflow_dispatch:
+
+# Cancel in-flight runs on the same ref so fast follow-up pushes
+# don't queue stale builds.
+concurrency:
+  group: docs-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build site
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+          cache-dependency-path: website/package-lock.json
+      - name: Install dependencies
+        working-directory: website
+        run: npm ci
+      - name: Type-check
+        working-directory: website
+        run: npm run typecheck
+      - name: Build
+        working-directory: website
+        run: npm run build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: website/build
+
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

website/.gitignore

@@ -0,0 +1,23 @@
+# Dependencies
+node_modules/
+
+# Production
+build/
+.docusaurus/
+.cache-loader/
+
+# Generated files
+.bundle-stats
+next/dist/
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

website/README.md

@@ -0,0 +1,30 @@
+# OpenScreen docs site
+
+Docusaurus 3 site. Lives in `website/` inside the monorepo. Deployed to GitHub Pages via `.github/workflows/docs.yml`.
+
+## Develop
+
+```sh
+cd website
+npm install
+npm run dev      # http://localhost:3000/openscreen/
+```
+
+## Build
+
+```sh
+npm run build    # outputs to website/build/
+npm run serve    # serves the built site locally
+```
+
+## Type-check
+
+```sh
+npm run typecheck
+```
+
+## Notes
+
+- Site URL: <https://getopenscreen.github.io/openscreen/>
+- The base URL is `/openscreen/` because the org-level Pages site hosts multiple projects.
+- Docs migration from `docs/` (root) → `website/docs/` happens in a follow-up PR. For now only the intro page is published.

website/docs/intro.md

@@ -0,0 +1,33 @@
+---
+id: intro
+title: Introduction
+sidebar_position: 1
+---
+
+# Welcome to OpenScreen
+
+OpenScreen is a **free, open-source screen recorder and editor** built on Electron, React, and Pixi.js. It uses native capture APIs (ScreenCaptureKit on macOS, Windows Graphics Capture on Windows) for low-overhead recording, and ships with a real multi-track editor.
+
+> OpenScreen is **not production-grade**. The project is in active development and rough edges are expected.
+
+## What you can do
+
+- Record screen, window, or region with system audio and microphone.
+- Edit on a multi-track timeline: trim, split, captions, cursor smoothing, webcam overlay.
+- Export to MP4 / WebM / GIF with Whisper-driven captions.
+- Bring your own LLM key if you want AI summaries or translations — otherwise everything runs locally.
+
+## Project facts
+
+- License: MIT. Free forever.
+- Platforms: Windows, macOS, Linux (packaging status varies — see the [project roadmap](https://github.com/getopenscreen/openscreen/blob/main/ROADMAP.md)).
+- Repo: [github.com/getopenscreen/openscreen](https://github.com/getopenscreen/openscreen)
+
+## Status of this site
+
+This is the landing page for the OpenScreen docs site. Full documentation migration lands in an upcoming PR. For now, the canonical sources live in the repo:
+
+- [`README.md`](https://github.com/getopenscreen/openscreen/blob/main/README.md)
+- [`CONTRIBUTING.md`](https://github.com/getopenscreen/openscreen/blob/main/CONTRIBUTING.md)
+- [`AGENTS.md`](https://github.com/getopenscreen/openscreen/blob/main/AGENTS.md)
+- [`docs/`](https://github.com/getopenscreen/openscreen/tree/main/docs)

website/docusaurus.config.ts

@@ -0,0 +1,114 @@
+import { themes as prismThemes } from "prism-react-renderer";
+import type { Config } from "@docusaurus/types";
+import type * as Preset from "@docusaurus/preset-classic";
+
+const config: Config = {
+	title: "OpenScreen",
+	tagline: "A free, open-source screen recorder and editor.",
+	favicon: "img/logo.svg",
+
+	url: "https://getopenscreen.github.io",
+	baseUrl: "/openscreen/",
+
+	organizationName: "getopenscreen",
+	projectName: "openscreen",
+
+	onBrokenLinks: "throw",
+
+	markdown: {
+		hooks: {
+			onBrokenMarkdownLinks: "warn",
+		},
+	},
+
+	presets: [
+		[
+			"@docusaurus/preset-classic",
+			{
+				docs: {
+					sidebarPath: "./sidebars.ts",
+					editUrl:
+						"https://github.com/getopenscreen/openscreen/tree/main/website/",
+				},
+				blog: false,
+			} satisfies Preset.Options,
+		],
+	],
+
+	themeConfig: {
+		image: "img/logo.svg",
+		colorMode: {
+			defaultMode: "light",
+			disableSwitch: false,
+			respectPrefersColorScheme: true,
+		},
+		navbar: {
+			title: "OpenScreen",
+			logo: {
+				alt: "OpenScreen",
+				src: "img/logo.svg",
+			},
+			items: [
+				{
+					type: "docSidebar",
+					sidebarId: "mainSidebar",
+					position: "left",
+					label: "Docs",
+				},
+				{
+					href: "https://github.com/getopenscreen/openscreen",
+					label: "GitHub",
+					position: "right",
+				},
+			],
+		},
+		footer: {
+			style: "dark",
+			links: [
+				{
+					title: "Project",
+					items: [
+						{
+							label: "GitHub",
+							href: "https://github.com/getopenscreen/openscreen",
+						},
+						{
+							label: "Releases",
+							href: "https://github.com/getopenscreen/openscreen/releases",
+						},
+					],
+				},
+				{
+					title: "Docs",
+					items: [
+						{
+							label: "Introduction",
+							to: "/",
+						},
+					],
+				},
+				{
+					title: "Community",
+					items: [
+						{
+							label: "Contributing",
+							href: "https://github.com/getopenscreen/openscreen/blob/main/CONTRIBUTING.md",
+						},
+						{
+							label: "License (MIT)",
+							href: "https://github.com/getopenscreen/openscreen/blob/main/LICENSE",
+						},
+					],
+				},
+			],
+			copyright:
+				"OpenScreen is released under the MIT license. Built by the community — free, forever.",
+		},
+		prism: {
+			theme: prismThemes.github,
+			darkTheme: prismThemes.dracula,
+		},
+	} satisfies Preset.ThemeConfig,
+};
+
+export default config;