Skip to content

Commit 2e07080

Browse files
committed
docs: restructure docs for MkDocs site, add GitHub Pages workflow
- Reorganize 14 source docs into architecture/, deployment/, labs/, project/, contributing/ subdirs - Add docs/index.md home page with full module table, architecture overview, phase tabs - Add mkdocs.yml with Material theme — tabs, dark mode, search, code copy - Add .github/workflows/docs.yml for auto-deploy to GitHub Pages - Add requirements-docs.txt (mkdocs-material, minify) - Remove 3 duplicate/timestamped doc files
1 parent 8e128d1 commit 2e07080

23 files changed

+307
-5843
lines changed

.github/workflows/docs.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Deploy Documentation to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'docs/**'
8+
- 'mkdocs.yml'
9+
- '.github/workflows/docs.yml'
10+
workflow_dispatch:
11+
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
concurrency:
18+
group: pages
19+
cancel-in-progress: false
20+
21+
jobs:
22+
build:
23+
runs-on: ubuntu-latest
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@v4
27+
with:
28+
fetch-depth: 0
29+
30+
- name: Set up Python
31+
uses: actions/setup-python@v5
32+
with:
33+
python-version: '3.12'
34+
cache: pip
35+
36+
- name: Install MkDocs and plugins
37+
run: pip install -r requirements-docs.txt
38+
39+
- name: Build documentation
40+
run: mkdocs build --strict
41+
42+
- name: Upload Pages artifact
43+
uses: actions/upload-pages-artifact@v3
44+
with:
45+
path: site/
46+
47+
deploy:
48+
needs: build
49+
runs-on: ubuntu-latest
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deploy.outputs.page_url }}
53+
steps:
54+
- name: Deploy to GitHub Pages
55+
id: deploy
56+
uses: actions/deploy-pages@v4
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)