Unified docs site: landing + /spec + /reference

NAOR YUVAL · NAOR YUVAL · commit 2c6bc74250ef · 2026-03-12T16:31:32.000+02:00
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,67 @@
+# Deploy unified MPCP docs to https://mpcp-protocol.github.io/
+# Site structure: / (landing) | /spec | /reference
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+  repository_dispatch:
+    types: [deploy-docs]
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout org site
+        uses: actions/checkout@v4
+
+      - name: Checkout mpcp-spec
+        uses: actions/checkout@v4
+        with:
+          repository: mpcp-protocol/mpcp-spec
+          path: mpcp-spec
+
+      - name: Checkout mpcp-reference
+        uses: actions/checkout@v4
+        with:
+          repository: mpcp-protocol/mpcp-reference
+          path: mpcp-reference
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install MkDocs
+        run: pip install -r docs-requirements.txt
+
+      - name: Build spec
+        run: |
+          cd mpcp-spec
+          pip install -r docs-requirements.txt -q
+          mkdocs build --config-file mkdocs.yml --strict
+          mv site ../_site_spec
+
+      - name: Build reference
+        run: |
+          cd mpcp-reference
+          pip install -r docs-requirements.txt -q
+          mkdocs build --config-file mkdocs.yml --strict
+          mv site ../_site_reference
+
+      - name: Assemble site
+        run: |
+          mkdir -p site
+          cp index.html site/
+          cp -r _site_spec site/spec
+          cp -r _site_reference site/reference
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# mpcp-protocol.github.io
+
+Unified documentation site for the Machine Payment Control Protocol (MPCP).
+
+**URL:** https://mpcp-protocol.github.io/
+
+**Structure:**
+- `/` — Landing page
+- `/spec/` — Protocol specification (from [mpcp-spec](https://github.com/mpcp-protocol/mpcp-spec))
+- `/reference/` — Reference implementation docs (from [mpcp-reference](https://github.com/mpcp-protocol/mpcp-reference))
+
+## Setup
+
+1. Create the `mpcp-protocol.github.io` repository in the mpcp-protocol organization.
+2. Push this content to `main`.
+3. GitHub Settings → Pages → Source: **Deploy from a branch** → Branch: **gh-pages**.
+4. The deploy workflow builds both sites and publishes on push to `main` or via manual trigger.
diff --git a/docs-requirements.txt b/docs-requirements.txt
@@ -0,0 +1,2 @@
+mkdocs>=1.5.0
+mkdocs-material>=9.0.0
diff --git a/index.html b/index.html
@@ -0,0 +1,55 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>MPCP — Machine Payment Control Protocol</title>
+  <style>
+    * { box-sizing: border-box; }
+    body {
+      font-family: system-ui, -apple-system, sans-serif;
+      max-width: 640px;
+      margin: 0 auto;
+      padding: 3rem 1.5rem;
+      line-height: 1.6;
+      color: #1e293b;
+    }
+    h1 { font-size: 1.75rem; font-weight: 600; margin-bottom: 0.5rem; }
+    p { color: #475569; margin: 0 0 1.5rem; }
+    .links {
+      display: flex;
+      gap: 1rem;
+      flex-wrap: wrap;
+      margin-top: 2rem;
+    }
+    .links a {
+      display: block;
+      padding: 1rem 1.5rem;
+      background: #f1f5f9;
+      color: #0f172a;
+      text-decoration: none;
+      border-radius: 8px;
+      font-weight: 500;
+      transition: background 0.2s;
+    }
+    .links a:hover { background: #e2e8f0; }
+    .links a strong { display: block; margin-bottom: 0.25rem; }
+    .links a span { font-size: 0.9rem; color: #64748b; }
+  </style>
+</head>
+<body>
+  <h1>Machine Payment Control Protocol</h1>
+  <p>A protocol for verifiable machine-to-service payments.</p>
+
+  <div class="links">
+    <a href="/spec/">
+      <strong>Spec</strong>
+      <span>Protocol specification, architecture, guides</span>
+    </a>
+    <a href="/reference/">
+      <strong>Reference</strong>
+      <span>Implementation docs, SDK, examples</span>
+    </a>
+  </div>
+</body>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+mkdocs>=1.5.0`
	`2`	`+mkdocs-material>=9.0.0`