Add astro based documentation website

.github/workflows/deploy-docs.yml

@@ -0,0 +1,44 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+  # Trigger the workflow every time you push to the `main` branch
+  # Using a different branch name? Replace `main` with your branch’s name
+  push:
+    branches: [main]
+  # Allows you to run this workflow manually from the Actions tab on GitHub.
+  workflow_dispatch:
+
+# Allow this job to clone the repo and create a page deployment
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout your repository using git
+        uses: actions/checkout@v2
+      - name: Install, build, and upload your site output
+        uses: withastro/action@v0
+        with:
+            path: docs # The root location of your Astro project inside the repository. (optional)
+            node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 16. (optional)
+            package-manager: npm # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

README.md

@@ -12,7 +12,7 @@ Engineers often need a complete copy of a system to develop on, even though they
 
 Linkup lets you create many "virtual copies" of a system, each with a different set of services running locally and remotely. We call each unique virtual copy a _linkup session_.
 
-![linkup-routing](./docs/linkup-routing.svg)
+![linkup-routing](./docs/src/assets/linkup-routing.svg)
 
 For example, Peter here can use a local copy of their web development server, but they can use the remote / shared backend server without having to run anything locally.
 

docs/.gitignore

@@ -0,0 +1,21 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store

docs/astro.config.mjs

@@ -0,0 +1,37 @@
+// @ts-check
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+
+
+// https://astro.build/config
+export default defineConfig({
+	integrations: [
+		starlight({
+			title: 'Linkup',
+			social: {
+				github: 'https://github.com/mentimeter/linkup',
+			},
+			sidebar: [
+				{
+					label: 'How To Guides',
+					autogenerate: { directory: 'how-to' },
+				},
+				{
+					label: 'Tutorials',
+					autogenerate: { directory: 'tutorials' },
+				},
+				{
+					label: 'Explanations',
+					autogenerate: { directory: 'explanation' },
+				},
+				{
+					label: 'Reference',
+					autogenerate: { directory: 'reference' },
+				},
+			],
+			customCss: [
+        './src/styles/custom.css',
+      ],
+		}),
+	],
+});